Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/CharlinFeng/Reflect

Reflection, Dict2Model, Model2Dict, Archive
https://github.com/CharlinFeng/Reflect

Last synced: 3 months ago
JSON representation

Reflection, Dict2Model, Model2Dict, Archive

Awesome Lists containing this project

README 

        
![image](./Reflect/logo.jpg)






##### 感谢小饭的翻译 [中文文档](https://github.com/nsdictionary/Reflect/blob/master/README_CN.md)



###Selfless pay, just to make you faster to conquer swift！



#### .Reflection

#### .convert dictionary to model

#### .convert model to dictionary

#### .convert plist to model

#### .One key archive








Reflect

===============




### Reflec

.iOS 7.0 


.Swift 2.0


.Xcode 7


.Reflection is available under the MIT license.








Installation

===============

you can just drag the Reflect files into your own project, without any third-party library.



Structure Details：


.Coding about archiving 


.Reflect  reflection core package


.Dict2Model convert  dictionary to  custom object


.Model2Dict convert custom object to dictionary



#### Tips

This frame already prepares many examples for lazy guys and it’s easy to see the result when u just use the methord

Person1.Convert(),Studetn1.Parse(),Book1.Action()


1.Parse-Parse8: convert dictionary to model


2.Convert1-Convert4: convert model to dictionary


3.Archiver1-Archiver3: One key archive








Core theory

===============

1. If you wanna use all the functions, all your custom model must inherit from `Reflect` Class.



2. It’s better to use implicitly optional type for properties. Try not to use strange type like var v1: [string?]? , var v2: [string!]! and this frame has lots of assertion to help you use data type reasonably.


3. This frame is based on requirement : parse json data into dictionaries then to model.

Limitation: reckon without complictated data like Core Data support; without consideration of Struct.










Reflect

===============

Call the properties of object directly can get the reflection for enumerations:



        p1.properties { (name, type, value) -> Void in

            println("\(name),\(type),\(value)")

        }



In addition, you can call class methods without initiate object while the value has no meaning:



        Person.properties { (name, type, _) -> Void in

            println("\(name),\(type)")

        }



The name is the property name of your model;

Type is the type of encapsulated ReflectType data;

Value is the value of variable;

You can also see the detail of properties by seeing the reference of ReflectType encapsulation. For example, the specific data type, if it is basic data type, if it is array, if it is optional, if it is object transferred from OC and if it is custom class.：




    var typeName: String!

    

    /**  analysis type from system  */

    var typeClass: Any.Type!

    

    var disposition: MirrorDisposition!

    

    var dispositionDesc: String!

    

    /**  whether it is optional  */

    var isOptional: Bool = false

    

    /**  whether it is array  */

    var isArray: Bool = false

    

    /**  real type: optional + array  */

    var realType: RealType = .None



In addition to above, I also add the function of  printing like OC so that you can directly print the object. For example, print Book1(book1 class is in Archiver1.swift of the projcet)

println(book1):



    println(book1)

    



the result of console would be:



    Reflect.Book1 <0x7a09fb10>: 

    {

    name: tvb

    price: 36.6

    }



ignore the field and field reflection of the process of analyzing additional features, subclass needs only rewrite the method.



    /**  property mapping  */

    

    //The model's property named 'userModel',get value width key 'user_model' from dictionay

    func mappingDict() -> [String: String]? {

        return ["userModel":"user_model"]

    }

     

     

    /**  property ignore */

    

    //Ignore the 'info' property of the model.

    func ignorePropertiesForParse() -> [String]? {

        return ["info"]

    }



You also can use the method below to complete converting from string to class



    let cls = ClassFromString("Reflect.Person")

  

attention, the string here include the name space 








convert dictionary to model

===============

it’s easy to convert dictionary to model, I already did the cascade im not going to repeat the details：



    let stu1 = Student1.parse(dict: Student1Dict)

    let stus = Student7.parses(arr: Student7DictArr)



If you property type is Bool, you may encounter UndefinedKey, which is due to Swift's own reasons, you just need to implement the following methods manually resolved:



    override func setValue(value: AnyObject?, forUndefinedKey key: String) {

        self.isVip = (value as! Int) != 0

    }



parse Plist file ,Please don't take the suffix



    let author = Author.parsePlist("Author")








convert model to dictionary

===============

it’s easy to convert model to dictionary, I already did the cascade im not going to repeat the details:



    let dict = person3.toDict()








One key archive

===============

Archive has done the cascade and easy for using. It also encapsulates the operation of Caches folder, directly save in Caches folder.



Archive: the name of  single model could be empty, but the name of array can’t be empty. Back to the position of archiving.



    let path1 =  Book2.save(obj: book2, name: nil)

    let path2 =  Book3.save(obj: bookArr, name: "book3")



Read data: please use the same key, if save name wich not used as nill, use nil for read data.



    let arcBook2 = Book2.read(name: nil)

    let arr = Book3.read(name: "book3")



delete data:



    Book1.delete(name: nil)



additional function: ignore archive field



    /**  ignore archive field  */

    

    //ignore archive property named 'icon'

    func ignoreCodingPropertiesForCoding() -> [String]? {

        return ["icon"]

    }