metamodel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0039698aeb5a6943fbab150f42314e52fb601203
+  data.tar.gz: a811eaa4d44154902463572ed3854c0f956b77e7
+SHA512:
+  metadata.gz: 3d73ffe24665ff900cabcf2c8ba7a72708fe3acc2061db5e7b898ac21488e1d6e2b2418b8d705c97e2cebda43bb7f399823aeeadf73bd96b4f436df3b4020b7d
+  data.tar.gz: 2c73680883d69b487d845cee94a8c07258006c4a87deb39ad768dcac83096b894ca2643bf4b3dc24b0c095531a9260870f4a8152f9d6651028c73dad9039e735

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Draveness
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+![MetaModel-banner](./images/banner.png)
+
+# MetaModel
+

data/bin/meta

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'metamodel'
+
+MetaModel::Command.run(ARGV)

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

@@ -0,0 +1,49 @@
+module MetaModel
+  class Command
+    class Build
+      class Parser
+
+        include Config::Mixin
+
+        require 'metamodel/model/cocoa_model'
+        require 'metamodel/model/cocoa_property'
+        require 'metamodel/model/property_constructor'
+        require 'metamodel/command/build/renderer'
+
+        def initialize
+          @models = []
+        end
+
+        def parse
+          title_options = { :verbose_prefix => '-> '.green }
+          UI.section "Analyzing scaffold files" do
+            scaffold_path = config.scaffold_path
+            scaffolds = Dir[scaffold_path + "*.rb"]
+            scaffolds.each do |scaffold_file|
+              UI.titled_section "Resolving `#{File.basename(scaffold_file)}`", title_options do
+                scaffold_code = File.read(scaffold_path + scaffold_file)
+                eval scaffold_code
+              end
+            end
+          end
+          @models
+        end
+
+        private
+
+        def metamodel_version(version)
+          raise Informative,
+            "Scaffold file #{version} not matched with current metamodel version #{VERSION}" if version != VERSION
+        end
+
+        def define(model_name)
+          model = CocoaModel.new(model_name)
+
+          yield PropertyConstructor.new(model)
+
+          @models << model
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+require 'erb'
+require 'ostruct'
+require 'xcodeproj'
+
+module MetaModel
+  class Command
+    class Build
+      class Renderer
+        class ErbalT < OpenStruct
+          def self.render_from_hash(t, h)
+            ErbalT.new(h).render(t)
+          end
+
+          def render(template)
+            ERB.new(template).result(binding)
+          end
+        end
+
+        class << self
+          def render(model)
+            template_path = File.expand_path(File.join(File.dirname(__FILE__), "../../template/model.swift.erb"))
+            template = File.read template_path
+
+            result = ErbalT::render_from_hash(template, { :model => model })
+            model_path = Pathname.new("./MetaModel/MetaModel/#{model.name}.swift")
+            File.write model_path, result
+
+            project = Xcodeproj::Project.open(Config.instance.metamodel_xcode_project)
+            target = project.targets.first
+
+            target.source_build_phase.files_references.each do |file_ref|
+              target.source_build_phase.remove_file_reference(file_ref) if file_ref && "#{model.name}.swift" == file_ref.name
+            end
+
+            models_group = project.main_group.find_subpath('MetaModel/Models', true)
+            models_group.clear
+            models_group.set_source_tree('SOURCE_ROOT')
+            file_ref = models_group.new_reference Pathname.new("MetaModel/#{model.name}.swift")
+            target.add_file_references [file_ref]
+
+            project.save
+
+          end
+        end
+
+        private
+
+      end
+    end
+  end
+end

data/lib/metamodel/command/build.rb

@@ -0,0 +1,63 @@
+require 'git'
+
+module MetaModel
+  class Command
+    class Build < Command
+      require 'metamodel/command/build/parser'
+      require 'metamodel/command/build/renderer'
+
+      self.summary = ""
+      self.description = <<-DESC
+
+      DESC
+
+      attr_accessor :models
+
+      def initialize(argv)
+        super
+      end
+
+      def run
+        UI.section "Building MetaModel project" do
+          clone_project
+          parse_template
+          render_model_files
+        end
+      end
+
+      def clone_project
+        if File.exist? config.metamodel_xcode_project
+          UI.message "Existing project `#{config.metamodel_xcode_project}`"
+        else
+          UI.section "Cloning MetaModel project into `./MetaModel` folder" do
+            Git.clone(config.metamodel_template_uri, 'MetaModel')
+            UI.message "Using `./MetaModel/MetaModel.xcodeproj` to build module"
+          end
+        end
+      end
+
+      def parse_template
+        parser = Parser.new
+        @models = parser.parse
+      end
+
+      def render_model_files
+        title_options = { :verbose_prefix => '-> '.green }
+        UI.section "Generating model files" do
+          @models.each do |model|
+            UI.titled_section "Using #{model.name}.swift file", title_options do
+              Renderer.render(model)
+            end
+          end
+        end
+      end
+
+      def validate!
+        super
+        raise Informative, 'No scaffold folder in directory' unless config.scaffold_path_in_dir(Pathname.pwd)
+      end
+
+      private
+    end
+  end
+end

data/lib/metamodel/command/clean.rb

@@ -0,0 +1,27 @@
+require 'fileutils'
+
+module MetaModel
+  class Command
+    class Clean < Command
+
+      self.summary = "Clean MetaModel project from current folder."
+      self.description = <<-DESC
+        Remove MetaModel folder which contains MetaModel.xcodeproj and model
+        files from current path.
+      DESC
+
+      def initialize(argv)
+        super
+      end
+
+      def run
+        UI.section "Removing MetaModel project" do
+          FileUtils.rm_rf 'MetaModel'
+          UI.message "Already clean up the whole MetaModel project from current folder"
+        end
+      end
+
+      private
+    end
+  end
+end

data/lib/metamodel/command/generate.rb

@@ -0,0 +1,44 @@
+module MetaModel
+  class Command
+    class Generate < Command
+
+      self.summary = "Generate a class skeleton for a model."
+      self.description = <<-DESC
+        Generate a skeleton for a Objective-C/Swift class and create
+        this file as model.rb in MetaModel folder.
+      DESC
+
+      def initialize(argv)
+        @model_name = argv.shift_argument
+        @file_path = config.scaffold_path + "#{@model_name.underscore}.rb"
+        super
+      end
+
+      def run
+        verify_scaffold_exists!
+        UI.section "Generating model scaffold file" do
+          title_options = { :verbose_prefix => '-> '.green }
+          UI.titled_section "Adding `#{File.basename(@file_path)}` to scaffold 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)}"
+        end
+      end
+
+      private
+
+      def model_template(model)
+        modelfile = ''
+        modelfile << "metamodel_version '#{VERSION}'\n\n"
+        modelfile << <<-TEMPLATE.strip_heredoc
+          define :#{model} do |j|
+            # define #{model} model like this
+            # j.nickname :string
+          end
+        TEMPLATE
+        modelfile
+      end
+    end
+  end
+end

data/lib/metamodel/command/init.rb

@@ -0,0 +1,33 @@
+module MetaModel
+  class Command
+
+    class Init < Command
+      self.summary = "Generate a scaffold folder for the current directory."
+      self.description = <<-DESC
+        Creates a scaffold 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'
+        @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?
+      end
+
+      def run
+        UI.section "Initiating MetaModel project" do
+          UI.section "Creating `scaffold` folder for MetaModel" do
+            FileUtils.mkdir(@scaffold_path)
+          end
+        end
+      end
+
+      private
+    end
+  end
+end

data/lib/metamodel/command.rb

@@ -0,0 +1,42 @@
+require 'colored'
+require 'claide'
+
+module MetaModel
+  class Command < CLAide::Command
+    require 'metamodel/command/init'
+    require 'metamodel/command/generate'
+    require 'metamodel/command/build'
+    require 'metamodel/command/clean'
+
+    include Config::Mixin
+
+    self.abstract_command = true
+    self.command = 'meta'
+    self.version = VERSION
+    self.description = 'MetaModel, the Model generator.'
+    self.plugin_prefixes = %w(claide meta)
+
+    def self.run(argv)
+      super(argv)
+    end
+
+    def initialize(argv)
+      super
+      # config.verbose = self.verbose?
+      config.verbose = true
+    end
+
+    #-------------------------------------------------------------------------#
+
+    private
+
+    # Checks that scaffold folder exists
+    #
+    # @return [void]
+    def verify_scaffold_exists!
+      unless config.scaffold_folder
+        raise Informative, "No `scaffold' folder found in the project directory."
+      end
+    end
+  end
+end

data/lib/metamodel/config.rb

@@ -0,0 +1,145 @@
+require 'active_support/multibyte/unicode'
+
+module MetaModel
+  # Stores the global configuration of MetaModel.
+  #
+  class Config
+
+    DEFAULTS = {
+      :verbose             => true,
+      :silent              => false,
+    }
+
+    public
+
+    #-------------------------------------------------------------------------#
+
+    # @!group UI
+
+    # @return [Bool] Whether CocoaPods should provide detailed output about the
+    #         performed actions.
+    #
+    attr_accessor :verbose
+    alias_method :verbose?, :verbose
+
+    public
+
+    #-------------------------------------------------------------------------#
+
+    # @!group Initialization
+
+    def verbose
+      @verbose && !silent
+    end
+
+    public
+
+    #-------------------------------------------------------------------------#
+
+    # @!group Paths
+
+    # @return [Pathname] the root of the MetaModel installation where the
+    #         scaffold 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)
+            @installation_root = current_path
+            break
+          else
+            current_path = current_path.parent
+          end
+        end
+        @installation_root ||= Pathname.pwd
+      end
+      @installation_root
+    end
+
+    attr_writer :installation_root
+    alias_method :project_root, :installation_root
+
+    # Returns the path of the metamodel template uri.
+    #
+    # @return [String]
+    #
+    def metamodel_template_uri
+      "git@github.com:Draveness/MetaModel-Template.git"
+    end
+
+    # Returns the path of the MetaModel.xcodeproj.
+    #
+    # @return [String]
+    #
+    def metamodel_xcode_project
+      "./MetaModel/MetaModel.xcodeproj"
+    end
+
+    # Returns whether or not scaffold folder is in current project.
+    #
+    # @return [Bool]
+    #
+    def scaffold_folder
+      Pathname.new(scaffold_path).exist?
+    end
+
+    # Returns the path of the scaffold.
+    #
+    # @return [Pathname]
+    # @return [Nil]
+    #
+    def scaffold_path
+      @scaffold_path_in_dir ||= installation_root + 'scaffold'
+    end
+
+    # Returns the path of the scaffold folder in the given dir if any exists.
+    #
+    # @param  [Pathname] dir
+    #         The directory where to look for the scaffold.
+    #
+    # @return [Pathname] The path of the scaffold.
+    # @return [Nil] If not scaffold was found in the given dir
+    #
+    def scaffold_path_in_dir(dir)
+      candidate = dir + 'scaffold'
+      if candidate.exist?
+        return candidate
+      end
+      nil
+    end
+
+    public
+
+    #-------------------------------------------------------------------------#
+
+    # @!group Singleton
+
+    # @return [Config] the current config instance creating one if needed.
+    #
+    def self.instance
+      @instance ||= new
+    end
+
+    # Sets the current config instance. If set to nil the config will be
+    # recreated when needed.
+    #
+    # @param  [Config, Nil] the instance.
+    #
+    # @return [void]
+    #
+    class << self
+      attr_writer :instance
+    end
+
+    # Provides support for accessing the configuration instance in other
+    # scopes.
+    #
+    module Mixin
+      def config
+        Config.instance
+      end
+    end
+  end
+end

data/lib/metamodel/model/cocoa_model.rb

@@ -0,0 +1,56 @@
+module MetaModel
+
+  class CocoaModel
+    attr_reader :name
+    attr_reader :properties
+
+    def initialize(name)
+      @name = name
+      @properties = []
+
+      validate
+    end
+
+    def properties_exclude_id
+      @properties.select { |property| property.key != :id }
+    end
+
+    def table_name
+      name.to_s.pluralize.underscore
+    end
+
+    def relation_name
+      "#{name}Relation"
+    end
+
+    def validate
+      property_keys = @properties.map { |property| property.key }
+
+      unless property_keys.include? :id
+        property_id = CocoaProperty.new(:id, :int, :primary)
+        @properties << property_id
+      end
+    end
+
+    def build_table
+      table = ""
+      @properties.each do |property|
+        property_key = property.key
+        if property.has_default_value?
+          default_value = property.default_value
+          if default_value.is_a? String
+            table << "t.column(#{property_key}, defaultValue: \"#{default_value}\")\n\t\t\t"
+          else
+            table << "t.column(#{property_key}, defaultValue: #{default_value})\n\t\t\t"
+          end
+        else
+          table << "t.column(#{property_key})\n\t\t\t"
+        end
+        table << "t.primaryKey(#{property_key})\n\t\t\t" if property.is_primary?
+        table << "t.unique(#{property_key})\n\t\t\t" if property.is_unique?
+      end
+      table
+    end
+  end
+
+end

data/lib/metamodel/model/cocoa_property.rb

@@ -0,0 +1,47 @@
+module MetaModel
+
+  class CocoaProperty
+    attr_reader :json_key
+    attr_reader :key
+    attr_reader :type
+    attr_reader :modifiers
+
+    def initialize(json_key, type = :string, *modifiers)
+      @json_key = json_key
+      @key = json_key.to_s.camelize(:lower).to_sym
+      @type = convert_symbol_to_type type
+
+      @modifiers = {}
+      @modifiers.default = false
+
+      modifiers.flatten.map do |modifier|
+        @modifiers[modifier] = true if modifier.is_a? Symbol
+        @modifiers[:default] = modifier[:default] if modifier.is_a? Hash and modifier[:default]
+      end
+    end
+
+    def is_unique?
+      @modifiers.include? :unique
+    end
+
+    def is_primary?
+      @modifiers.include? :primary
+    end
+
+    def has_default_value?
+      @modifiers[:default].nil?
+    end
+
+    def default_value
+      modifiers[:default]
+    end
+
+    private
+
+    def convert_symbol_to_type(symbol)
+      symbol.to_s.capitalize
+    end
+
+  end
+
+end

data/lib/metamodel/model/property_constructor.rb

@@ -0,0 +1,31 @@
+module MetaModel
+
+  class PropertyConstructor
+
+    attr_reader :model
+
+    def initialize(model)
+      @model = model
+    end
+
+    def method_missing(meth, *arguments, &block)
+      (class << self; self; end).class_eval do
+        define_method meth do |type, *arguments|
+          save_property CocoaProperty.new(meth, type, arguments)
+        end
+      end
+      self.send meth, *arguments
+    end
+
+    private
+
+    # Save property to current Cocoa Model
+    #
+    # @param [CocoaProperty] the instance for cocoa property
+    # @return [Void]
+    def save_property(property)
+      @model.properties << property
+    end
+  end
+
+end