gyro 0.4.0 → 1.0.0

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

@@ -0,0 +1,61 @@
+# 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'
+
+if Gem::Version.new(Liquid::VERSION) < Gem::Version.new('4.0.0')
+  module Gyro
+    module Generator
+      # This allows to support whitespace trimming (which is only supported in Liquid 4) when using Liquid 3.0
+      # It works by patching Liquid::Template using ruby's `Module#prepend` feature
+      # See http://stackoverflow.com/a/4471202/803787 for more info on Monkey-Patching in Ruby
+      #
+      module LiquidWhitespacePatch
+        # Patch for Liquid::Template class
+        #
+        module Template
+          def parse(source, options = {})
+            super(source.gsub(/\s*{%-/, "\v{%").gsub(/-%}\s*/, "%}\v"), options)
+          end
+
+          def render(*params)
+            super(*params).delete("\v")
+          end
+        end
+
+        # Patch for Liquid's String extension
+        #
+        module String
+          def to_liquid
+            super.delete("\v")
+          end
+        end
+      end
+    end
+  end
+
+  module Liquid
+    # Monkey-Patch Liquid::Template class
+    #
+    class Template
+      prepend Gyro::Generator::LiquidWhitespacePatch::Template
+    end
+  end
+
+  # Monkey-Patch String
+  #
+  class String
+    prepend Gyro::Generator::LiquidWhitespacePatch::String
+  end
+end

data/lib/gyro/log.rb

@@ -0,0 +1,46 @@
+# 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
+  # Print nice and colored output for various error/success/title messages of Gyro
+  #
+  module Log
+    @quiet = false
+    def self.quiet=(value)
+      @quiet = value
+    end
+
+    def self.title(str) # bg yellow
+      puts "\n\e[44;37m#{str}\e[0m" unless @quiet
+    end
+
+    def self.error(str)
+      puts "\e[1;31m! #{str}\e[0m" unless @quiet
+    end
+
+    def self.info(str)
+      puts "\e[1;33m> #{str}\e[0m" unless @quiet
+    end
+
+    def self.success(str)
+      puts "\e[1;32m√ #{str}\e[0m" unless @quiet
+    end
+
+    def self.fail!(message, stacktrace: false)
+      Gyro::Log.error message
+      raise message if stacktrace
+      exit 1
+    end
+  end
+end

data/lib/gyro/parser/xcdatamodel.rb

@@ -0,0 +1,20 @@
+# 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 'nokogiri'
+
+require 'gyro/parser/xcdatamodel/xcdatamodel'
+require 'gyro/parser/xcdatamodel/attribute'
+require 'gyro/parser/xcdatamodel/relationship'
+require 'gyro/parser/xcdatamodel/entity'

data/lib/gyro/parser/xcdatamodel/attribute.rb

@@ -0,0 +1,129 @@
+# 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 Parser
+    module XCDataModel
+      # One Attribute in an Entity of the xcdatamodel
+      #
+      class Attribute
+        attr_accessor :entity_name, :name, :type, :optional, :indexed, :default
+        attr_accessor :realm_ignored, :realm_read_only, :enum_type, :enum_values
+        attr_accessor :json_key_path, :json_values, :transformer, :comment, :support_annotation
+
+        alias optional? optional
+        alias indexed? indexed
+        alias realm_ignored? realm_ignored
+
+        # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        def initialize(attribute_xml, entity_name)
+          @entity_name = entity_name
+          @name = attribute_xml.xpath('@name').to_s
+          @optional = attribute_xml.xpath('@optional').to_s == 'YES'
+          @indexed = attribute_xml.xpath('@indexed').to_s == 'YES'
+          @default = attribute_xml.xpath('@defaultValueString').to_s
+          @type = attribute_xml.xpath('@attributeType').to_s.downcase.tr(' ', '_').to_sym
+          @realm_ignored = !Gyro::Parser::XCDataModel.user_info(attribute_xml, 'realmIgnored').empty?
+          @realm_read_only = Gyro::Parser::XCDataModel.user_info(attribute_xml, 'realmReadOnly')
+          @enum_type = Gyro::Parser::XCDataModel.user_info(attribute_xml, 'enumType')
+          @enum_values = Gyro::Parser::XCDataModel.user_info(attribute_xml, 'enumValues').split(',')
+          @json_key_path = Gyro::Parser::XCDataModel.user_info(attribute_xml, 'JSONKeyPath')
+          @json_values = Gyro::Parser::XCDataModel.user_info(attribute_xml, 'JSONValues').split(',')
+          @transformer = Gyro::Parser::XCDataModel.user_info(attribute_xml, 'transformer').strip
+          @comment = Gyro::Parser::XCDataModel.user_info(attribute_xml, 'comment')
+          @support_annotation = Gyro::Parser::XCDataModel.user_info(attribute_xml, 'supportAnnotation')
+          search_for_error
+        end
+
+        def to_h
+          {
+            'entity_name' => entity_name, 'name' => name,
+            'type' => type.to_s,
+            'optional' => optional,
+            'indexed' => indexed,
+            'default' => default,
+            'realm_ignored' => realm_ignored, 'realm_read_only' => realm_read_only,
+            'enum_type' => enum_type, 'enum_values' => enum_values,
+            'json_key_path' => json_key_path, 'json_values' => json_values,
+            'transformer' => transformer, 'need_transformer' => need_transformer?,
+            'comment' => comment,
+            'support_annotation' => support_annotation,
+            'is_decimal' => decimal?, 'is_integer' => integer?, 'is_number' => number?, 'is_bool' => bool?
+          }
+        end
+        # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+        def enum?
+          !@enum_type.empty?
+        end
+
+        def read_only?
+          !@realm_read_only.empty?
+        end
+
+        def default?
+          !@default.empty?
+        end
+
+        def to_s
+          items = [
+            "name=#{@name}",
+            "type=#{@type}",
+            "optional=#{@optional}",
+            "default=#{@default}",
+            "indexed=#{@indexed}"
+          ]
+          "\tAttribute => " + items.join(' | ') + "\n"
+        end
+
+        def decimal?
+          (@type == :decimal) || (@type == :double) || (@type == :float)
+        end
+
+        def integer?
+          (@type == :integer_16) || (@type == :integer_32) || (@type == :integer_64)
+        end
+
+        def number?
+          decimal? || integer?
+        end
+
+        def bool?
+          @type == :boolean
+        end
+
+        def need_transformer?
+          !@enum_type.empty? || (@type == :boolean) || (@type == :date) || !@transformer.empty?
+        end
+
+        private ################################################################
+
+        def search_for_error
+          # rubocop:disable Style/GuardClause
+          if @type == :undefined || @type.empty?
+            msg = %(The attribute "#{@name}" from "#{@entity_name}" has no type - please fix it)
+            Gyro::Log.fail!(msg, stacktrace: true)
+          end
+          if !@json_key_path.empty? && !@enum_values.empty? && (@enum_values.size != @json_values.size)
+            message = %(The attribute "#{@name}" from "#{@entity_name}" is wrongly annotated:) +
+                      %(when declaring an type with enum and JSONKeyPath, you must have the same number of items) +
+                      %(in the 'enumValues' and 'JSONValues' annotations.)
+            Gyro::Log.fail!(message, stacktrace: true)
+          end
+          # rubocop:enable Style/GuardClause
+        end
+      end
+    end
+  end
+end

data/lib/gyro/parser/xcdatamodel/entity.rb

@@ -0,0 +1,195 @@
+# 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 Parser
+    module XCDataModel
+      # One Entity in the xcdatamodel
+      #
+      class Entity
+        attr_accessor :name, :parent, :abstract, :attributes, :relationships, :identity_attribute, :comment
+        alias abstract? abstract
+
+        # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        def initialize(entity_xml)
+          @name = entity_xml.xpath('@name').to_s
+          @parent = entity_xml.xpath('@parentEntity').to_s
+          @abstract = entity_xml.xpath('@isAbstract').to_s == 'YES' ? true : false
+          @clean = false
+          @identity_attribute = Gyro::Parser::XCDataModel.user_info(entity_xml, 'identityAttribute')
+          @comment = Gyro::Parser::XCDataModel.user_info(entity_xml, 'comment')
+          @attributes = {}
+          @relationships = {}
+          load_entity(entity_xml)
+        end
+
+        def to_h
+          {
+            'attributes' => attributes.values.map(&:to_h),
+            'relationships' => relationships.values.map(&:to_h),
+            'name' => name,
+            'parent' => parent,
+            'abstract' => abstract,
+            'identity_attribute' => identity_attribute,
+            'comment' => comment,
+            'has_no_inverse_relationship' => no_inverse_relationship?,
+            'has_ignored' => ignored_attributes_relationships?, 'has_required' => required_attributes?,
+            'has_primary_key' => primary_key?, 'has_indexed_attributes' => indexed_attributes?,
+            'has_json_key_path' => json_key_paths?, 'has_enum_attributes' => enum_attributes?,
+            'has_custom_transformers' => custom_transformers?, 'need_transformer' => need_transformer?,
+            'has_bool_attributes' => bool_attributes?,
+            'has_number_attributes' => number_attributes?,
+            'has_date_attribute' => date_attributes?,
+            'has_list_relationship' => list_relationships?,
+            'has_list_attributes' => list_attributes?,
+            'has_only_inverse' => only_inverse_relationships?
+          }
+        end
+        # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+        def to_s
+          "\nEntity => #{@name}\n" +
+            @attributes.map { |_, attr| attr.to_s } +
+            @relationships.map { |_, rel| rel.to_s }
+        end
+
+        def used_as_list_by_other?(entities)
+          entities.any? do |_, entity|
+            entity.relationships.any? do |_, relationship|
+              (relationship.inverse_type == @name) && (relationship.type == :to_many)
+            end
+          end
+        end
+
+        def list_attributes?(include_inverse = false)
+          @relationships.any? do |_, relationship|
+            (relationship.type == :to_many) && (include_inverse ? true : !relationship.inverse?)
+          end
+        end
+
+        def no_inverse_relationship?
+          @relationships.none? { |_, relationship| relationship.inverse? }
+        end
+
+        def ignored_attributes?
+          @attributes.any? { |_, attribute| attribute.realm_ignored? }
+        end
+
+        def ignored_relationships?
+          @relationships.any? { |_, relationship| relationship.realm_ignored? }
+        end
+
+        def ignored_attributes_relationships?
+          ignored_attributes? || ignored_relationships?
+        end
+
+        def primary_key?
+          !@identity_attribute.empty?
+        end
+
+        def required_attributes?
+          @attributes.any? { |_, attribute| required?(attribute) }
+        end
+
+        def required?(attribute)
+          return false if attribute.optional?
+          return true unless primary_key?
+          return true if primary_key? && !attribute.name.eql?(identity_attribute)
+        end
+
+        def default_value?(attribute)
+          attribute.name != @identity_attribute
+        end
+
+        def indexed_attributes?
+          @attributes.any? { |_, attribute| attribute.indexed? }
+        end
+
+        def json_key_paths?
+          @attributes.any? do |_, attribute|
+            !attribute.json_key_path.empty?
+          end || @relationships.any? do |_, relationship|
+            !relationship.inverse? && !relationship.json_key_path.empty?
+          end
+        end
+
+        def enum_attributes?
+          @attributes.any? { |_, attribute| !attribute.enum_type.empty? }
+        end
+
+        def transformers
+          transformers = Set.new
+          @attributes.each do |_, attribute|
+            transformers.add attribute.transformer unless attribute.transformer.empty?
+          end
+          transformers
+        end
+
+        def custom_transformers?
+          @attributes.any? { |_, attribute| !attribute.transformer.empty? }
+        end
+
+        def need_transformer?
+          enum_attributes? || bool_attributes? || custom_transformers? || date_attributes?
+        end
+
+        def bool_attributes?
+          @attributes.any? { |_, attribute| attribute.type == :boolean }
+        end
+
+        NUMBER_TYPES = %i[integer_16 integer_32 integer_64 decimal double float].freeze
+        def number_attributes?
+          @attributes.any? do |_, attribute|
+            attribute.enum_type.empty? && NUMBER_TYPES.include?(attribute.type)
+          end
+        end
+
+        def date_attributes?
+          @attributes.any? { |_, attribute| attribute.type == :date }
+        end
+
+        def list_relationships?
+          @relationships.any? { |_, relationship| !relationship.destination.empty? }
+        end
+
+        def only_inverse_relationships?
+          @relationships.all? { |_, relationship| relationship.inverse? }
+        end
+
+        private ################################################################
+
+        def load_entity(entity_xml)
+          load_attributes(entity_xml)
+          load_relationships(entity_xml)
+        end
+
+        def load_attributes(entity_xml)
+          entity_xml.xpath('attribute').each do |node|
+            attribute = Attribute.new(node, @name)
+            if attribute.type != 'Transformable'
+              @attributes[attribute.name] = attribute
+            end
+          end
+        end
+
+        def load_relationships(entity_xml)
+          entity_xml.xpath('relationship').each do |node|
+            relationship = Relationship.new(node, @name)
+            @relationships[relationship.name] = relationship
+          end
+        end
+      end
+    end
+  end
+end