metamodel 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7736cf1e138517c6079cfc3c290f943ad285bbee
-  data.tar.gz: 75cc11f484c32d1a54ef70d457ba9d83a89f75d0
+  metadata.gz: 5027faa28bcf3e7d87ba3e152f2f812562237c49
+  data.tar.gz: b78d7293ab4a90fdc831f6e7b94b2d802d306f9a
 SHA512:
-  metadata.gz: dbad5e08fb83943368a289a2bdf7602b20297a7267f5bcabc5ada3f9264b0ee8a1d8c19e0ee6c5fdc5034094897000486a1b0e3ddcbf8eaa2e304c36d326b2fd
-  data.tar.gz: 0359d81ec9bcd81b30fa7ae9d7056fc7214dde6ed7b8e57dccba885a7195113f7671f8db6aa791602f7818168d28a846d2b271761a50a130915f818a4dbcbc18
+  metadata.gz: c4f4929a6cebae8736d7783a493312251ea668942ab6689f09ad032669f2bce5432ed985402af02e3ed4a27669502c85e6eb3934b515616d2d3a1f47f982bbfe
+  data.tar.gz: 24de521af1ada8393bb874aab884be227cdbee438c0984a403535b311131011175340d0e0d78426672c719b866e710aa917009522b9834999494596e1872b1d8

data/README.md

@@ -5,7 +5,7 @@
 [![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/draveness/metamodel/blob/master/LICENSE)
 [![Gem](https://img.shields.io/gem/v/metamodel.svg?style=flat)](http://rubygems.org/gems/metamodel)
 
-MetaModel is an iOS framework that includes everything about model layer, data persistent, JSON to model constructor and a bunch of APIs which provides a way of dealing with client side database very easily.
+MetaModel is an iOS framework designed to help developer to deal with data persistent, JSON to model constructor and a bunch of APIs which provides an approach of handling client side database very easily.
 
 > MetaModel is under-development, API may constantly change before gets to 1.0.0.
 
@@ -13,11 +13,30 @@ MetaModel is an iOS framework that includes everything about model layer, data p
 + [x] Dealing with database without writing SQL
 + [x] Most concise API to retrieve data from persistent level
 
-Use a scaffold file to define your model:
+MetaModel provides convenience chainable APIs to manipulate models like ActiveRecord.
 
-```ruby
-metamodel_version '0.0.1'
+```swift
+let json = ["id": 1, "name": "Buzz", "email": "i@metamodel.info"]
+let person = Person.parse(json)
+
+// INSERT INTO "people" (id, name, email) VALUES (1, "Buzz", "i@metamodel.info")
+person.save
 
+// SELECT "people".* FROM "people" WHERE "people"."id" = 1 LIMIT 1
+if var person = Person.find(1) {
+    // UPDATE "people" SET "people"."name") = "Buzz" WHERE "people"."id" = 1
+    person.update(name: "Draven")
+}
+
+// SELECT "people".* FROM "people"
+print(Person.all)
+```
+
+## Usage
+
+Use a meta file in `./meta` folder to define your model:
+
+```ruby
 define :User do |j|
   # define User model like this
   j.nickname :string
@@ -38,7 +57,7 @@ sudo gem install metamodel --verbose
 
 ## Quick Start
 
-After installation , run `meta init` in your iOS project root folder which will make a `scaffold` directory in current folder.
+After installation , run `meta init` in your iOS project root folder which will make a `meta` directory in current folder.
 
 ```shell
 $ cd /path/to/project
@@ -46,24 +65,24 @@ $ meta init
 
 Initialing MetaModel project
 
-Creating `scaffold` folder for MetaModel
+Creating `meta` folder for MetaModel
 ```
 
-Generate your model scaffold file with `meta generate`.
+Generate your model meta file with `meta generate`.
 
 ```shell
 $ meta generate User
 
-Generating model scaffold file
+Generating model meta file
 
--> Adding `user.rb` to scaffold folder
+-> Adding `user.rb` to meta folder
 
 [!] `user.rb` has already generated, use the command below to edit it.
 
-  vim scaffold/user.rb
+  vim meta/user.rb
 ```
 
-Edit scaffold file using vim, Emacs or other editor and run `meta build`.
+Edit meta file using vim, Emacs or other editor and run `meta build`.
 
 ```shell
 $ meta build
@@ -73,7 +92,7 @@ Building MetaModel project
 Cloning MetaModel project into `./MetaModel` folder
 Using `./MetaModel/MetaModel.xcodeproj` to build module
 
-Analyzing scaffold files
+Analyzing meta files
 -> Resolving `user.rb`
 
 Generating model files

data/lib/metamodel/command.rb

@@ -30,12 +30,12 @@ module MetaModel
 
     private
 
-    # Checks that scaffold folder exists
+    # Checks that meta folder exists
     #
     # @return [void]
-    def verify_scaffold_exists!
-      unless config.scaffold_folder
-        raise Informative, "No `scaffold' folder found in the project directory."
+    def verify_meta_exists!
+      unless config.meta_folder
+        raise Informative, "No `meta' folder found in the project directory."
       end
     end
   end

data/lib/metamodel/command/build.rb

@@ -57,7 +57,7 @@ module MetaModel
 
       def validate!
         super
-        raise Informative, 'No scaffold folder in directory' unless config.scaffold_path_in_dir(Pathname.pwd)
+        raise Informative, 'No meta folder in directory' unless config.meta_path_in_dir(Pathname.pwd)
       end
 
       private

data/lib/metamodel/command/build/parser.rb

@@ -15,13 +15,13 @@ module MetaModel
         end
 
         def parse
-          UI.section "Analyzing scaffold files" do
-            scaffold_path = config.scaffold_path
-            scaffolds = Dir[scaffold_path + "*.rb"]
-            scaffolds.each do |scaffold_file|
-              UI.message '-> '.green + "Resolving `#{File.basename(scaffold_file)}`"
-              scaffold_code = File.read(scaffold_path + scaffold_file)
-              eval scaffold_code
+          UI.section "Analyzing meta files" do
+            meta_path = config.meta_path
+            metas = Dir[meta_path + "*.rb"]
+            metas.each do |meta_file|
+              UI.message '-> '.green + "Resolving `#{File.basename(meta_file)}`"
+              meta_code = File.read(meta_path + meta_file)
+              eval meta_code
             end
           end
           @models
@@ -31,7 +31,7 @@ module MetaModel
 
         def metamodel_version(version)
           raise Informative,
-            "Scaffold file #{version} not matched with current metamodel version #{VERSION}" if version != VERSION
+            "Meta file #{version} not matched with current metamodel version #{VERSION}" if version != VERSION
         end
 
         def define(model_name)

data/lib/metamodel/command/generate.rb

@@ -10,19 +10,19 @@ module MetaModel
 
       def initialize(argv)
         @model_name = argv.shift_argument
-        @file_path = config.scaffold_path + "#{@model_name.underscore}.rb"
+        @file_path = config.meta_path + "#{@model_name.underscore}.rb"
         super
       end
 
       def run
-        verify_scaffold_exists!
-        UI.section "Generating model scaffold file" do
+        verify_meta_exists!
+        UI.section "Generating model meta file" do
           title_options = { :verbose_prefix => '-> '.green }
-          UI.titled_section "Adding `#{File.basename(@file_path)}` to scaffold folder", title_options do
+          UI.titled_section "Adding `#{File.basename(@file_path)}` to meta folder", title_options do
             @file_path.open('w') { |f| f << model_template(@model_name) }
           end
           UI.notice "`#{File.basename(@file_path)}` has already generated, use the command below to edit it.\n"
-          UI.message "vim scaffold/#{File.basename(@file_path)}"
+          UI.message "vim meta/#{File.basename(@file_path)}"
         end
       end
 

data/lib/metamodel/command/init.rb

@@ -2,27 +2,27 @@ module MetaModel
   class Command
 
     class Init < Command
-      self.summary = "Generate a scaffold folder for the current directory."
+      self.summary = "Generate a meta folder for the current directory."
       self.description = <<-DESC
-        Creates a scaffold folder for the current directory if none exits. Call
+        Creates a meta folder for the current directory if none exits. Call
         this command before all other metamodel command.
       DESC
 
       def initialize(argv)
-        @scaffold_path = Pathname.pwd + 'scaffold'
+        @meta_path = Pathname.pwd + 'meta'
         @project_path = argv.shift_argument
         super
       end
 
       def validate!
         super
-        raise Informative, 'Existing scaffold folder in directory' unless config.scaffold_path_in_dir(Pathname.pwd).nil?
+        raise Informative, 'Existing meta folder in directory' unless config.meta_path_in_dir(Pathname.pwd).nil?
       end
 
       def run
         UI.section "Initialing MetaModel project" do
-          UI.section "Creating `scaffold` folder for MetaModel" do
-            FileUtils.mkdir(@scaffold_path)
+          UI.section "Creating `meta` folder for MetaModel" do
+            FileUtils.mkdir(@meta_path)
           end
         end
       end

data/lib/metamodel/config.rb

@@ -39,14 +39,14 @@ module MetaModel
     # @!group Paths
 
     # @return [Pathname] the root of the MetaModel installation where the
-    #         scaffold folder is located.
+    #         meta folder is located.
     #
     def installation_root
       current_dir = ActiveSupport::Multibyte::Unicode.normalize(Dir.pwd)
       current_path = Pathname.new(current_dir)
       unless @installation_root
         until current_path.root?
-          if scaffold_path_in_dir(current_path)
+          if meta_path_in_dir(current_path)
             @installation_root = current_path
             break
           else
@@ -77,33 +77,33 @@ module MetaModel
       "./MetaModel/MetaModel.xcodeproj"
     end
 
-    # Returns whether or not scaffold folder is in current project.
+    # Returns whether or not meta folder is in current project.
     #
     # @return [Bool]
     #
-    def scaffold_folder
-      Pathname.new(scaffold_path).exist?
+    def meta_folder
+      Pathname.new(meta_path).exist?
     end
 
-    # Returns the path of the scaffold.
+    # Returns the path of the meta.
     #
     # @return [Pathname]
     # @return [Nil]
     #
-    def scaffold_path
-      @scaffold_path_in_dir ||= installation_root + 'scaffold'
+    def meta_path
+      @meta_path_in_dir ||= installation_root + 'meta'
     end
 
-    # Returns the path of the scaffold folder in the given dir if any exists.
+    # Returns the path of the meta folder in the given dir if any exists.
     #
     # @param  [Pathname] dir
-    #         The directory where to look for the scaffold.
+    #         The directory where to look for the meta.
     #
-    # @return [Pathname] The path of the scaffold.
-    # @return [Nil] If not scaffold was found in the given dir
+    # @return [Pathname] The path of the meta.
+    # @return [Nil] If not meta was found in the given dir
     #
-    def scaffold_path_in_dir(dir)
-      candidate = dir + 'scaffold'
+    def meta_path_in_dir(dir)
+      candidate = dir + 'meta'
       if candidate.exist?
         return candidate
       end

data/lib/metamodel/model/cocoa_model.rb

@@ -32,6 +32,10 @@ module MetaModel
       end
     end
 
+    def hash_value
+      self.hash.to_s(16)
+    end
+
     def property_key_value_pairs
       @properties.map { |property| "#{property.key.to_s}: #{property.key.to_s}" }.join(", ")
     end
@@ -40,8 +44,13 @@ module MetaModel
       @properties.map { |property| "#{property.key.to_s}: #{property.type.to_s}" }.join(", ")
     end
 
-    def property_exclude_id_key_value_pairs(prefix = true)
-      result = properties_exclude_id.map { |property| "#{property.key.to_s}: #{property.key.to_s}" }.join(", ")
+    def property_exclude_id_key_value_pairs(prefix = true, cast = false)
+      result = ""
+      if cast
+        result = properties_exclude_id.map { |property| "#{property.key.to_s}: #{property.type_without_optional == "Int" ? "Int(#{property.key.to_s})" : property.key.to_s}" }.join(", ")
+      else
+        result = properties_exclude_id.map { |property| "#{property.key.to_s}: #{property.key.to_s}" }.join(", ")
+      end
       return result unless prefix
       return result.length > 0 ? ", #{result}" : ""
     end

data/lib/metamodel/model/cocoa_property.rb

@@ -36,6 +36,10 @@ module MetaModel
       end
     end
 
+    def real_type
+      type_without_optional == "Int" ? "Int64" : type_without_optional
+    end
+
     def is_unique?
       @modifiers.include? :unique
     end

data/lib/metamodel/template/initialize.swift.erb

@@ -3,4 +3,8 @@ extension <%= model.name %> {
         let initializeTableSQL = "<%= model.build_table %>"
         executeSQL(initializeTableSQL)
     }
+    static func deinitialize() {
+        let dropTableSQL = "DROP TABLE \(tableName.unwrapped)"
+        executeSQL(dropTableSQL)
+    }
 }

data/lib/metamodel/template/instance_methods.swift.erb

@@ -6,35 +6,33 @@ public extension <%= model.name %> {
         executeSQL(deleteSQL)
     }
 
-    <% model.properties_exclude_id.each do |property| %>
-    <%= """mutating func update(#{property.key} #{property.key}: #{property.type}) -> #{model.name} {
+    <% model.properties_exclude_id.each do |property| %><%= """mutating func update(#{property.key} #{property.key}: #{property.type}) -> #{model.name} {
         return self.update([.#{property.key}: #{property.key}])
     }""" %>
     <% end %>
-
     mutating func update(attributes: [<%= model.name %>.Column: Any]) -> <%= model.name %> {
         var setSQL: [String] = []
         for (key, _) in attributes {
             switch key {
-            <% model.properties_exclude_id.each do |property| %>
-            <%= """case .#{property.key}: setSQL.append(\"\(key.unwrapped) = \(self.(#{property.key}#{property.is_optional? ? "?" : ""}.unwrapped)\")
-            """ %>
-            <% end %>
-            default: break
+            <% model.properties_exclude_id.each do |property| %><%= """case .#{property.key}: setSQL.append(\"\\(key.unwrapped) = \\(#{property.key}#{property.is_optional? ? "?" : ""}.unwrapped)\")""" %>
+            <% end %>default: break
             }
         }
         let updateSQL = "UPDATE \(<%= model.name %>.tableName.unwrapped) SET \(setSQL.joinWithSeparator(", ")) \(itself)"
         executeSQL(updateSQL) {
             for (key, value) in attributes {
                 switch key {
-                <% model.properties_exclude_id.each do |property| %>
-                <%= """case .#{property.key}: self.#{property.key} = value as#{property.is_optional? ? "?" : "!"} #{property.type_without_optional}
-                """ %>
-                <% end %>
-                default: break
+                <% model.properties_exclude_id.each do |property| %><%= """case .#{property.key}: self.#{property.key} = value as#{property.is_optional? ? "?" : "!"} #{property.type_without_optional}""" %>
+                <% end %>default: break
                 }
             }
         }
         return self
     }
+    var save: <%= model.name %> {
+        get {
+            <%= model.name %>.create(id<%= model.property_exclude_id_key_value_pairs %>)
+            return self
+        }
+    }
 }

data/lib/metamodel/template/json.swift.erb

@@ -1,16 +1,28 @@
 extension <%= model.name %> {
-    public init(json: [String: Any]) {
+    public static func parse(json: [String: AnyObject]) -> <%= model.name %> {
         let id: Int = json["id"] as! Int
         <% model.properties_exclude_id.each do |property| %>
-        <%= """let #{property.key}: #{property.type} = json[\"#{property.key}\"] as! #{property.type}
-        """ %>
+        <%= """let #{property.key}: #{property.type} = json[\"#{property.key}\"] as! #{property.type}""" %>
         <% end %>
+        return <%= model.name %>(<%= model.property_key_value_pairs %>)
+    }
+
+    public static func parse(jsons: [[String: AnyObject]]) -> [<%= model.name %>] {
+        var results: [<%= model.name %>] = []
+        for json in jsons {
+            results.append(<%= model.name %>.parse(json))
+        }
+        return results
+    }
 
-        self.init(<%= model.property_key_value_pairs %>)
+    public static func parse(data: NSData) throws -> <%= model.name %> {
+        let json = try NSJSONSerialization.JSONObjectWithData(data, options: .AllowFragments) as! [String: AnyObject]
+        return <%= model.name %>.parse(json)
     }
 
-    public init(jsonData: NSData) throws {
-        let json = try NSJSONSerialization.JSONObjectWithData(jsonData, options: .AllowFragments) as! [String: Any]
-        self.init(json: json)
+    public static func parses(data: NSData) throws -> [<%= model.name %>] {
+        let json = try NSJSONSerialization.JSONObjectWithData(data, options: .AllowFragments) as! [[String: AnyObject]]
+        return <%= model.name %>.parse(json)
     }
+
 }

data/lib/metamodel/template/metamodel.swift.erb

@@ -17,12 +17,22 @@ let db =  try! Connection("\(path)/metamodel_db.sqlite3")
 
 public class MetaModel {
     public static func initialize() {
+        validateMetaModelTables()
         <% models.each do |model| %><%= "#{model.name}.initialize()" %>
         <% end %>
     }
+    static func validateMetaModelTables() {
+        createMetaModelTable()
+        let infos = retrieveMetaModelTableInfos()
+        <% models.each do |model| %><%= """if infos[#{model.name}.tableName] != \"#{model.hash_value}\" {
+            updateMetaModelTableInfos(#{model.name}.tableName, hashValue: \"#{model.hash_value}\")
+            #{model.name}.deinitialize()
+        }""" %>
+        <% end %>
+    }
 }
 
-func executeSQL(sql: String, success: (() -> ())? = nil) -> Statement? {
+func executeSQL(sql: String, silent: Bool = false, success: (() -> ())? = nil) -> Statement? {
     defer { print("\n") }
     print("-> Begin Transaction")
     let startDate = NSDate()

data/lib/metamodel/template/recordable.swift.erb

@@ -1,10 +1,7 @@
 extension <%= model.name %>: Recordable {
     public init(values: Array<Optional<Binding>>) {
-        let id: Int64 = values[0] as! Int64
-        <% model.properties_exclude_id.each_with_index do |property, index| %>
-        <%= """let #{property.key}: #{property.type} = values[#{index + 1}] as! #{property.type}
-        """ %>
+        <% model.properties.each_with_index do |property, index| %><%= """let #{property.key}: #{property.real_type} = values[#{index}] as! #{property.real_type}""" %>
         <% end %>
-        self.init(id: Int(id)<%= model.property_exclude_id_key_value_pairs %>)
+        self.init(id: Int(id)<%= model.property_exclude_id_key_value_pairs(true, true) %>)
     }
 }

data/lib/metamodel/version.rb

@@ -1,5 +1,5 @@
 module MetaModel
   # The version of the MetaModel command line tool.
   #
-  VERSION = '0.0.2'.freeze unless defined? MetaModel::MetaModel
+  VERSION = '0.0.3'.freeze unless defined? MetaModel::MetaModel
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metamodel
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Draveness Zuo
@@ -157,7 +157,6 @@ files:
 - lib/metamodel/template/instance_methods.swift.erb
 - lib/metamodel/template/json.swift.erb
 - lib/metamodel/template/metamodel.swift.erb
-- lib/metamodel/template/model.swift.erb
 - lib/metamodel/template/model_query.swift.erb
 - lib/metamodel/template/model_relation.swift.erb
 - lib/metamodel/template/recordable.swift.erb
@@ -184,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: The Cocoa models generator.

data/lib/metamodel/template/model.swift.erb

@@ -1,122 +0,0 @@
-//
-//  <%= model.name %>.swift
-//  MetaModel
-//
-//  Created by MetaModel script.
-//
-
-import Foundation
-import SQLite
-
-public struct <%= model.name %> {
-    public let id: Int
-    <% model.properties_exclude_id.each do |property| %>
-    <%= """public var #{property.key}: #{property.type} {
-      didSet { try! db.run(itself.update(#{model.name}.#{property.key} <- #{property.key})) }
-    }""" %>
-    <% end %>
-}
-
-extension <%= model.name %>: Recordable {
-    public init(record: SQLite.Row) {
-      self.init(<%= model.properties.map { |property| "#{property.key}: record[#{model.name}.#{property.key}]" }.join(", ") %>)
-    }
-}
-
-extension <%= model.name %> {
-    static let table = Table("<%= "#{model.table_name}" %>")
-    <% model.properties.each do |property| %><%= "static let #{property.key} = Expression<#{property.type}>(\"#{property.key}\")" %>
-    <% end %>
-    var itself: QueryType { get { return <%= model.name %>.table.filter(<%= model.name %>.id == self.id) } }
-
-    static func createTable() {
-        let _ = try? db.run(table.create { t in
-            <%= model.build_table.chop %>
-        })
-    }
-}
-
-public extension <%= model.name %> {
-    static func deleteAll() {
-        let _ = try? db.run(<%= model.name %>.table.delete())
-    }
-
-    static func count() -> Int {
-        return db.scalar(<%= model.name %>.table.count)
-    }
-
-    static func create(<%= model.properties.map { |property| "#{property.key}: #{property.type}" }.join(", ") %>) -> <%= model.name %> {
-        let insert = <%= model.name %>.table.insert(<%= model.properties.map { |property| "#{model.name}.#{property.key} <- #{property.key}" }.join(", ") %>)
-        let _ = try? db.run(insert)
-        return <%= model.name %>(<%= model.properties.map { |property| "#{property.key}: #{property.key}" }.join(", ") %>)
-    }
-
-}
-
-public extension <%= model.name %> {
-    func delete() {
-        try! db.run(itself.delete())
-    }
-    <% model.properties_exclude_id.each do |property| %>
-    <%= """mutating func update(#{property.key} #{property.key}: #{property.type}) -> #{model.name} {
-        self.#{property.key} = #{property.key}
-        return self
-    }""" %>
-    <% end %>
-}
-
-
-public extension <%= model.name %> {
-    static private func findAll(query: QueryType) -> [<%= model.name %>] {
-        var result: [<%= model.name %>] = []
-        for record in try! db.prepare(query) {
-            result.append(<%= model.name %>(record: record))
-        }
-        return result
-    }
-
-    static var all: <%= model.relation_name %> {
-        get {
-            return <%= model.relation_name %>()
-        }
-    }
-    <% model.properties.each do |property| %>
-    <%= """static func findBy(#{property.key} #{property.key}: #{property.type}) -> #{model.relation_name} {
-        return #{model.relation_name}().findBy(#{property.key}: #{property.key})
-    }""" %>
-    <% end %>
-    static func limit(length: Int, offset: Int = 0) -> <%= model.relation_name %> {
-        return <%= model.relation_name %>().limit(length, offset: offset)
-    }
-
-    static func group(params: Expressible...) -> <%= model.relation_name %> {
-        return <%= model.relation_name %>().group(params)
-    }
-}
-
-public class <%= model.relation_name %>: Relation<<%= model.name %>> {
-    init() {
-        super.init(query: <%= model.name %>.table)
-    }
-
-    <% model.properties.each do |property| %>
-    <%= """public func findBy(#{property.key} #{property.key}: #{property.type}) -> Self {
-        query = query.filter(#{model.name}.#{property.key} == #{property.key})
-        return self
-    }""" %>
-    <% end %>
-    public func limit(length: Int, offset: Int = 0) -> Self {
-        query = query.limit(length, offset: offset)
-        return self
-    }
-
-    public func group(params: Expressible...) -> Self {
-        return group(params)
-    }
-
-    public func group(params: [Expressible]) -> Self {
-        query = query.group(params)
-        return self
-    }
-
-}