gyro 0.4.0 → 1.0.0

data/bin/gyro

@@ -1,118 +1,125 @@
 #!/usr/bin/env ruby
 
-=begin
-Copyright 2016 - Niji
+# Copyright 2016 - Niji
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-=end
-
-if RUBY_VERSION < '2.0.0'
-  abort 'error: gyro requires Ruby 2 or higher.'
-end
+abort 'error: gyro requires Ruby 2 or higher.' if RUBY_VERSION < '2.0.0'
 
 require 'gyro'
 require 'optparse'
+require 'pathname'
 
 dir = Dir.pwd
 options = {
-    :model => nil,
-    :android_dir => nil,
-    :package => nil,
-    :ios_dir => nil,
-    :ios_json => false,
-    :ios_framework => false,
-    :ios_swift => false
+  model: nil,
+  template: nil,
+  output: nil,
+  params: {}
 }
 
-OptionParser.new do |opts|
+parser = OptionParser.new do |opts|
   opts.banner = 'Usage: gyro [options]'
-  opts.on('-m PATH', '--model PATH', %q(Specify Interface Builder .xcdatamodel file)) do |path|
-    options[:model] = path
-  end
-  opts.on('-a PATH', '--android PATH', %q(Specify Android Realm model classes dir)) do |path|
-    options[:android_dir] = path
+  opts.on('-m PATH', '--model PATH', 'The .xcdatamodel file to use') do |xcdatamodel_path|
+    options[:model] = xcdatamodel_path
   end
-  opts.on('-p PATH', '--package PATH', %q(Specify Android Realm model classes package name)) do |path|
-    options[:package] = path
+  opts.on('-t DIR', '--template DIR',
+          'Path to the template directory to use, or name of a template embedded in gyro',
+          '(see --list for available names)') do |path|
+    options[:template] = path
   end
-  opts.on('-i PATH', '--ios PATH', %q(Specify iOS Realm model classes dir)) do |path|
-    options[:ios_dir] = path
+  opts.on('-o DIR', '--output DIR',
+          'Path to the output directory where to generate the model files') do |path|
+    options[:output] = path
   end
-  opts.on('-j', '--json', %q(Additionally generate Realm-JSON categories (Objective-C) or ObjectMapper artifacts (Swift))) do
-    options[:ios_json] = true
+  opts.on('-p KEY:VALUE', '--param KEY:VALUE',
+          'Specify a custom parameter that can be used by the template.',
+          'Can be repeated to add more parameters') do |params|
+    (k, *v) = params.split(':')
+    options[:params] = options[:params].merge(k.to_s => v.join(':').to_s)
   end
-  opts.on('-f', '--framework', %q(If you use CocoaPods Frameworks instead of static libraries)) do
-    options[:ios_framework] = true
+  opts.on('-l', '--list', 'List the names of all available templates provided by gyro') do
+    Gyro::Template.print_list
+    exit
   end
-  opts.on('-s', '--swift', %q(If you use Swift as iOS language)) do
-    options[:ios_swift] = true
+  opts.on('-i', '--info TEMPLATE',
+          'Show information about the given template',
+          '(path to directory or name of an embedded template)') do |template|
+    Gyro::Template.print_infos(template)
+    exit
   end
-  opts.on('-n', '--nsnumber', %q(To generate NSNumbers instead of Int/BOOL/Float types)) do
-    options[:wrappers] = true
+  opts.on_tail('-h', '--help', 'Show this message') do
+    puts opts
+    exit 1
   end
-  opts.on('-w', '--wrappers', %q(To generate Java primitive wrappers for optional fields instead of primitive types)) do
-    options[:wrappers] = true
+  opts.on_tail('-v', '--version', 'Show version') do
+    puts Gyro::VERSION
+    exit
   end
-  opts.on('-x', '--annotations', %q(To tag code with Android support annotations according to optional/non optional fields)) do
-    options[:annotations] = true
-  end
-  opts.on_tail('-h', '--help', %q(Show this message)) { puts opts; exit 1 }
-  opts.on_tail('-v', '--version', 'Show version') { puts Gyro::VERSION; exit }
-  opts.parse!
+end
+
+begin
+  parser.parse!(ARGV)
+rescue OptionParser::ParseError => e
+  Gyro::Log.error(e)
+  puts parser
+  exit 1
 end
 
 if options[:model].nil?
-  Gyro::Log::info('No model provided, trying to find one in the local directory…')
-  options[:model] = Gyro.find_xcdatamodel(dir)
-  Gyro::Log::info("Unable to find any .xcdatamodel in #{dir}") if options[:model].nil?
+  Gyro::Log.info('No model provided, trying to find one in the local directory…')
+  options[:model] = Gyro::Parser::XCDataModel.find_in_dir(dir)
+  Gyro::Log.info("Unable to find any .xcdatamodel in #{dir}") if options[:model].nil?
 end
 
 if options[:model].nil?
-  Gyro.exit_with_error('You need to specify .xcdatamodel path using --model option (see --help for more info)')
+  Gyro::Log.fail!('You need to specify .xcdatamodel path using --model option (see --help for more info)')
 else
   basename = File.basename(options[:model])
   dirname = File.dirname(options[:model])
-  Gyro::Log::success("Using #{basename} in #{dirname}")
+  Gyro::Log.success("Using #{basename} in #{dirname}")
 end
 
-# Android
-if options[:android_dir].nil?
-  Gyro::Log::info('You need to specify a dir using --android option to generate Android Realm model classes (see --help for more info)')
-else
-  if Dir.exist?(options[:android_dir])
-    if options[:package].nil?
-      Gyro::Log::info('You need to specify an Android package name using --package option (see --help for more info)')
-    else
-      xcdatamodel = Gyro::XCDataModel::Parser::XCDataModel.new(options[:model])
-      Gyro::Realm::Java::Generator.new(options[:android_dir], options[:package], xcdatamodel, options[:wrappers], options[:annotations])
-    end
-  else
-    Gyro::Log::info('You need to specify a valid Android Realm model classes dir')
-  end
+# Liquid Templates
+if options[:template].nil?
+  # Generate JSON if no -t is specified
+  Gyro::Log.info('Note: You can specify a template using the --template option (see --help for more info)')
+  xcdatamodel = Gyro::Parser::XCDataModel::XCDataModel.new(options[:model])
+  Gyro::Generator::Json.new(xcdatamodel)
+  exit
 end
 
-# iOS
-if options[:ios_dir].nil?
-  Gyro::Log::info('You need to specify a dir using --ios option to generate iOS Realm model classes (see --help for more info)')
-else
-  if Dir.exist?(options[:ios_dir])
-    xcdatamodel = Gyro::XCDataModel::Parser::XCDataModel.new(options[:model])
-    if options[:ios_swift]
-      Gyro::Realm::Swift::Generator.new(options[:ios_dir], xcdatamodel, options[:ios_json])
-    else
-      Gyro::Realm::ObjC::Generator.new(options[:ios_dir], xcdatamodel, options[:ios_json], options[:ios_framework], options[:wrappers])
-    end
-  else
-    Gyro::Log::info('You need to specify a valid iOS Realm model classes dir')
-  end
+template_dir = Gyro::Template.find(options[:template])
+
+if options[:output].nil?
+  Gyro::Log.fail!('You need to specify output directory path using --output option (see --help for more info)')
 end
+
+output_dir = Pathname.new(options[:output])
+
+unless output_dir.exist?
+  Gyro::Log.fail!("The output directory #{output_dir} does not exist. Please create it first.")
+end
+
+puts <<-INFO.gsub(/  \|/, '')
+  |
+  |#===================================
+  |# Template    : #{template_dir}
+  |# Output Dir  : #{output_dir}
+  |# Params      : #{options[:params].inspect}
+  |#===================================
+INFO
+
+xcdatamodel = Gyro::Parser::XCDataModel::XCDataModel.new(options[:model])
+gen = Gyro::Generator::Liquid.new(template_dir, output_dir, options[:params])
+gen.generate(xcdatamodel)

data/lib/gyro.rb

@@ -1,32 +1,21 @@
-=begin
-Copyright 2016 - Niji
+# Copyright 2016 - Niji
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+require 'gyro/version'
 
-    http://www.apache.org/licenses/LICENSE-2.0
+require 'gyro/parser/xcdatamodel'
+require 'gyro/generator/json'
+require 'gyro/generator/liquid'
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-=end
-
-require File.expand_path('gyro/xcdatamodel/parser/xcdatamodel', File.dirname(__FILE__))
-require File.expand_path('gyro/realm/java/generator', File.dirname(__FILE__))
-require File.expand_path('gyro/realm/objc/generator', File.dirname(__FILE__))
-require File.expand_path('gyro/realm/swift/generator', File.dirname(__FILE__))
-require File.expand_path('gyro/utils/log', File.dirname(__FILE__))
-require File.expand_path('gyro/utils/file_utils', File.dirname(__FILE__))
-
-module Gyro
-  VERSION = '0.4.0'
-
-  def self.exit_with_error(message)
-    Gyro::Log::error message
-    exit 1
-  end
-
-end
+require 'gyro/log'

data/lib/gyro/generator/json.rb

@@ -0,0 +1,30 @@
+# Copyright 2016 - Niji
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'json'
+require 'gyro/parser/xcdatamodel'
+
+module Gyro
+  module Generator
+    # Generates the JSON representation of the input datamodel
+    #
+    class Json
+      # PUBLIC METHODS #######################################################
+      def initialize(xcdatamodel)
+        Gyro::Log.title('Generating JSON')
+        puts JSON.pretty_generate(xcdatamodel.to_h)
+      end
+    end
+  end
+end

data/lib/gyro/generator/liquid.rb

@@ -0,0 +1,22 @@
+# Copyright 2016 - Niji
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'liquid'
+require 'pathname'
+
+require 'gyro/parser/xcdatamodel'
+require 'gyro/template'
+require 'gyro/generator/liquid/liquid'
+require 'gyro/generator/liquid/whitespace_patch'
+require 'gyro/generator/liquid/filters'

data/lib/gyro/generator/liquid/filters.rb

@@ -0,0 +1,53 @@
+# Copyright 2016 - Niji
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Gyro
+  module Generator
+    # Declare some custom Liquid Filters used by the template, then render it
+    #
+    module LiquidFilters
+      def escape_quotes(input)
+        input.gsub('"', '\"')
+      end
+
+      def snake_to_camel_case(input)
+        input.split('_').map(&:capitalize).join
+      end
+
+      def snake_case(input)
+        input.gsub(/::/, '/')
+             .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+             .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+             .tr('-', '_')
+             .downcase
+      end
+
+      def uncapitalize(input)
+        input_strip = input.strip
+        input_strip[0, 1].downcase + input_strip[1..-1]
+      end
+
+      def titleize(input)
+        input_strip = input.strip
+        input_strip[0, 1].upcase + input_strip[1..-1]
+      end
+
+      def delete_objc_prefix(input)
+        i = 0
+        i += 1 while i < input.length - 1 && /[[:upper:]]/.match(input[i + 1])
+        input[i..input.length]
+      end
+    end
+  end
+end

data/lib/gyro/generator/liquid/liquid.rb

@@ -0,0 +1,124 @@
+# Copyright 2016 - Niji
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Gyro
+  module Generator
+    # Generates arbitrary output from the input datamodel, using a Liquid template provided by the user
+    #
+    class Liquid
+      attr_accessor :params, :output_dir
+
+      # PUBLIC METHODS #######################################################
+
+      # rubocop:disable Metrics/AbcSize
+      def initialize(template_dir, output_dir, params)
+        Gyro::Log.title('Generating Model')
+
+        @params = params
+        @output_dir = Pathname.new(output_dir)
+
+        # Define Template path for Liquid file system to use Include Tag
+        ::Liquid::Template.file_system = ::Liquid::LocalFileSystem.new(template_dir)
+
+        @entity_template = load_template(template_dir + 'entity.liquid', false)
+        @entity_filename_template = load_template(template_dir + 'entity_filename.liquid', true)
+        @enum_template = load_template(template_dir + 'enum.liquid', false)
+        enum_fn_tpl = template_dir + 'enum_filename.liquid'
+        enum_fn_tpl = template_dir + 'filename.liquid' unless enum_fn_tpl.exist?
+        @enum_filename_template = load_template(enum_fn_tpl, true)
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      def generate(xcdatamodel)
+        generate_entities(xcdatamodel)
+        Gyro::Log.success('Model objects are generated !')
+      end
+
+      private ################################################################
+
+      def load_template(template_path, prevent_return_line)
+        unless template_path.exist?
+          Gyro::Log.fail!('Bad template directory content ! Your template needs a ' + template_path.to_s + ' file')
+        end
+        template_path_string = template_path.read
+        if prevent_return_line && template_path_string.include?("\n")
+          msg = 'The given template ' + template_path.to_s + ' contains return line(s). This can lead to side effets.'
+          Gyro::Log.error(msg)
+        end
+        ::Liquid::Template.parse(template_path_string)
+      end
+
+      def generate_entities(xcdatamodel)
+        xcdatamodel.to_h['entities'].each do |entity|
+          entity_context = { 'params' => @params, 'entity' => entity }
+          # Rendering template using entity and params context
+          output = render_entity(entity_context)
+          # Don't generate empty output
+          next if output.delete("\n").empty?
+
+          filename_context = { 'params' => @params, 'name' => entity['name'] }
+          # Rendering filename template using entity name and params context
+          filename = render_filename(filename_context)
+          Gyro::Log.success("#{filename} is created !")
+          # Write model object
+          File.write(@output_dir + filename, output)
+          # Generate model object enums
+          generate_enums(entity['attributes'])
+        end
+      end
+
+      def generate_enums(attributes)
+        enums = []
+        attributes.each do |attribute|
+          enum_type = attribute['enum_type']
+          next if enums.include?(enum_type) || enum_type.empty?
+          enums.push(enum_type)
+
+          enum_context = { 'params' => @params, 'attribute' => attribute }
+          # Rendering enum template using attribute and params context
+          output = render_enum(enum_context)
+          # Don't generate empty output
+          next if output.delete("\n").empty?
+
+          generate_enum(enum_type, output)
+        end
+      end
+
+      def generate_enum(enum_name, output)
+        # Rendering enum filename template using enum name and params context
+        enum_filename_context = { 'params' => @params, 'name' => enum_name }
+        enum_filename = render_enum_filename(enum_filename_context)
+        File.write(@output_dir + enum_filename, output)
+      end
+
+      def render_entity(context)
+        @entity_template.render(context, filters: [Gyro::Generator::LiquidFilters])
+                        .gsub(/^ +$/, '')
+      end
+
+      def render_filename(context)
+        @entity_filename_template.render(context).chomp
+      end
+
+      def render_enum(context)
+        @enum_template.render(context, filters: [Gyro::Generator::LiquidFilters])
+                      .gsub(/^ +$/, '')
+      end
+
+      def render_enum_filename(context)
+        @enum_filename_template.render(context).chomp
+      end
+    end
+  end
+end