zenangst / Spots

:bamboo: Spots is a cross-platform view controller framework for building component-based UIs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

func configure(_ item: inout Item) change.

navisingh opened this issue · comments

Now that func configure(_ vm: inout Item) {...} has changed to func configure(with item: Item) {...}
How are we supposed to modify item? What is the new API for that?

Hey @navisingh, the idea behind that change is that you shouldn't mutate your data source from the view. We saw this in a flaw in our architecture and decided to change it as constantly mutating the model can cause a lot of undesired behavior.

What kind of manipulations did you make to your Item that you can no longer do? We basically only changed the size of the item, this is now provided by the following method:

func computeSize(for item: Item, containerSize: CGSize) -> CGSize

If you provide some more detail information on what kind of mutation you see yourself performing I'd gladly brainstorm a bit on how you can achieve that 😎

The view has editable fields. The data is stored in the underlying models. Now that is broken. I will now have to maintain another family of models outside your framework. That sucks. Wish you can go back to inout. I built a whole lot of code around this framework.

@navisingh
Ah! Yeah that really sucks that we broke your code and let me be the first one to apologize for that. When doing editing forms (like you are doing here) it might be better to set up a delegate for the view and handle the incoming text that way. That would mean that you wouldn't have to mutate your model.

The reason behind this change is that we want to avoid mutating the model as that could easily lead to unwanted behavior.

In fact, we are looking into removing additional properties on Item and instead relying on client side models. We have an ongoing PR to support this #740.

If you could share some code on what you are doing in your app I would gladly help to figure out a more feasible solution for you. And again, sorry for breaking your implementation, that was never the intension. We just felt that using inout here was bad design and was holding us back (and the cause for some bugs as it led to undesired and unexpected mutation).

'''
extension DynamicCellInput: SpotConfigurable {

func configure(_ vm: inout Item) {
    model = vm.metaModel as? T

    if let model = model {
        model.delegate = self
        model.cellType = DynamicCellInput.self
        cellLabel.text = model.label
        
        cellTextfield.isSecureTextEntry = model.dataType == DynamicModelInput.DataTypes.password.rawValue //"password"

        if model.dataType == DynamicModelInput.DataTypes.username.rawValue { //"username"
            cellTextfield.autocorrectionType = .no
            cellTextfield.autocapitalizationType = .none
        } else {
            cellTextfield.autocorrectionType = .default
            cellTextfield.autocapitalizationType = .sentences
        }
   
        if let hint = model.hint {
            cellTextfield.placeholder = hint
        }
        if let df = model.defaultValue {
            cellTextfield.text = df
        } else {
            cellTextfield.text = ""
        }

        cellLabel.sizeToFit(width: 120)
        
        textFieldWidthConstraint?.constant = self.frame.size.width - cellLabel.frame.size.width - 38
        
        updateConstraints()

        vm.size.height = 50
        
        logDebug("DynamicCellCenterText: cell height: \(vm.size.height) : \(preferredViewSize.height)")
        
        self.layoutSubviews()
    }
}

@objc func textFieldDidChange(_ sender: UITextField) {
    
    if self.model?.dataType == ACElementDataType.email().getValue() {
    
        model?.dirty = EmailDataValidator.validateEmail(sender.text) == nil
        
    } else if let text = sender.text, text.length > 0 {
        model?.dirty = true
    } else {
        model?.dirty = false
    }
    DynamicListVC.currentVC?.refresh(self)
}

@objc func textFieldEditingDidEnd(_ sender: UITextField) {
    
    let text = cellTextfield.text
    model?.defaultValue = text
}

}
'''
The above code is for a tableviewcell that takes text input. It then modifies a field in the underlying model.

The viewcontroller then grabs the values from the models for all cells, and sends them to the server.

We could probably do a discussion on Gitter to resolve this. Please ping me on Gitter so we can go over this. Thanks.