gyro 0.4.0 → 1.0.0

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

@@ -0,0 +1,84 @@
+# 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 Relationship between attributes in the xcdatamodel
+      #
+      class Relationship
+        attr_accessor :entity_name, :name, :type, :optional, :deletion_rule
+        attr_accessor :inverse_name, :inverse_type, :json_key_path, :support_annotation
+        attr_accessor :realm_ignored
+        attr_accessor :destination
+
+        alias realm_ignored? realm_ignored
+
+        # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        def initialize(relationship_xml, entity_name)
+          @entity_name = entity_name
+          @name = relationship_xml.xpath('@name').to_s
+          @optional = relationship_xml.xpath('@optional').to_s == 'YES' ? true : false
+          @deletion_rule = relationship_xml.xpath('@deletionRule').to_s
+          @inverse_name = relationship_xml.xpath('@inverseName').to_s
+          @inverse_type = relationship_xml.xpath('@destinationEntity').to_s
+          @json_key_path = Gyro::Parser::XCDataModel.user_info(relationship_xml, 'JSONKeyPath')
+          @realm_ignored = Gyro::Parser::XCDataModel.user_info(relationship_xml, 'realmIgnored').empty? ? false : true
+          @support_annotation = Gyro::Parser::XCDataModel.user_info(relationship_xml, 'supportAnnotation')
+          load_type(relationship_xml)
+          @destination = Gyro::Parser::XCDataModel.user_info(relationship_xml, 'destination')
+          search_for_error
+        end
+
+        def to_h
+          { 'entity_name' => entity_name, 'name' => name, 'type' => type.to_s,
+            'optional' => optional, 'deletion_rule' => deletion_rule,
+            'inverse_name' => inverse_name, 'inverse_type' => inverse_type,
+            'json_key_path' => json_key_path, 'support_annotation' => support_annotation,
+            'realm_ignored' => realm_ignored, 'destination' => destination, 'inverse' => inverse? }
+        end
+        # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+        def to_s
+          "\tRelationship => name=#{@name} | type=#{@type} | optional=#{@optional} | deletion_rule=#{@deletion_rule}\n"
+        end
+
+        def inverse?
+          @name.end_with?('_')
+        end
+
+        private ################################################################
+
+        def load_type(relationship_xml)
+          max_count = relationship_xml.xpath('@maxCount').to_s
+          @type = !max_count.nil? && (max_count == '1') ? :to_one : :to_many
+        end
+
+        def search_for_error
+          # rubocop:disable Style/GuardClause
+          if inverse_type.empty? && destination.empty?
+            message = %(The relationship "#{@name}" from "#{@entity_name}" is wrong - please fix it)
+            Gyro::Log.fail!(message, stacktrace: true)
+          end
+          if !destination.empty? && type != :to_many
+            message = %(The relationship "#{@name}" from "#{@entity_name}" is wrong - ) +
+                      %(please set a 'No Value' relationship as 'To Many')
+            Gyro::Log.fail!(message, stacktrace: true)
+          end
+          # rubocop:enable Style/GuardClause
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# 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
+    # Parser for CoreData's xcdatamodel files
+    #
+    module XCDataModel
+      def self.find_in_dir(dir)
+        Dir.chdir(dir) do
+          files = Dir.glob('*.xcdatamodel')
+          files.first.nil? ? nil : File.expand_path(files.first, dir)
+        end
+      end
+
+      def self.user_info(xml, key)
+        xml.xpath("userInfo/entry[@key='#{key}']/@value").to_s
+      end
+
+      # Represents the whole xcdatamodel file struture, once parsed
+      #
+      class XCDataModel
+        attr_accessor :entities
+
+        def initialize(xcdatamodel_dir)
+          contents_file = File.join(xcdatamodel_dir, 'contents')
+          Gyro::Log.fail!('Unable to find contents of xcdatamodel', stacktrace: true) unless File.exist?(contents_file)
+          @entities = {}
+          file = File.open(contents_file)
+          document_xml = Nokogiri::XML(file).remove_namespaces!
+          file.close
+          load_entities(document_xml)
+        end
+
+        def to_h
+          { 'entities' => entities.values.map(&:to_h) }
+        end
+
+        def to_s
+          @entities.values.map(&:to_s).join
+        end
+
+        private
+
+        def load_entities(document_xml)
+          document_xml.xpath('//entity').each do |node|
+            entity = Entity.new(node)
+            @entities[entity.name] = entity
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gyro/template.rb

@@ -0,0 +1,68 @@
+# 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
+  # Gyro Template Helper
+  #
+  module Template
+    def self.print_list
+      Gyro::Template.directory.children.select(&:directory?).each do |entry|
+        puts " - #{entry.basename}"
+      end
+    end
+
+    def self.print_infos(template)
+      readme = if template.include?('/')
+                 Pathname.new(template) + 'README.md'
+               else
+                 Gyro::Template.directory + template + 'README.md'
+               end
+
+      Gyro::Log.fail!("No README.md found for template #{template}.") unless readme.exist?
+      puts readme.read
+    end
+
+    def self.directory
+      Pathname.new(File.dirname(__FILE__)) + '../templates'
+    end
+
+    def self.find(template_param)
+      if template_param.include? '/'
+        find_by_path(template_param)
+      else
+        find_by_name(template_param)
+      end
+    end
+
+    def self.find_by_path(path)
+      template_dir = Pathname.new(path)
+      unless template_dir.exist?
+        Gyro::Log.fail!('You need to specify existing template directory using --template option' \
+                        ' (see --help for more info)')
+      end
+
+      return template_dir if template_dir.directory?
+      return template_dir.dirname if template_dir.file?
+      Gyro::Log.fail!('You need to specify right template directory using --template option' \
+                      ' (see --help for more info)')
+    end
+
+    def self.find_by_name(name)
+      template_dir = Gyro::Template.directory + name
+      return template_dir if template_dir.exist?
+      Gyro::Log.fail!('You need to specify existing default template name using --template option' \
+                      ' (see --help for more info)')
+    end
+  end
+end

data/lib/gyro/version.rb

@@ -0,0 +1,19 @@
+# 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.
+
+# Gyro Version
+#
+module Gyro
+  VERSION = '1.0.0'.freeze
+end

data/lib/templates/android/README.md

@@ -0,0 +1,164 @@
+# Android Template Information
+
+| Name      | Description       |
+| --------- | ----------------- |
+| Folder name | templates/android |
+| Invocation example | `gyro -m <model> -t android …` |
+| Language | Java |
+
+If you want to use this template you need to work with `Realm`.
+
+# Caracteristics
+
+In this template you have additional parameters to inject constants : 
+
+- package (ex : **com.gyro.model.realm**)
+- use_wrappers (define if you want to use wrapper types (ex Boolean) instead of primitive types (ex boolean) when you attribute is **optional** inside xcdatamodel)
+- support_annotations (you can define annotation for properties ex : **@android.support.annotation.IntRange(from=0,to=255)** or **@android.support.annotation.Nullable**)
+
+# Usage
+
+
+Package exemple :
+
+```bash
+gyro -m <model> -t android -o <output> --param package:com.gyro.model.realm
+```
+
+Use wrappers exemple :
+
+```bash
+gyro -m <model> -t android -o <output> --param use_wrappers:true
+```
+
+Support annotations exemple :
+
+```bash
+gyro -m <model> -t android -o <output> --param support_annotations:true
+```
+
+And you can combine options :
+
+```bash
+gyro -m <model> -t android -o <output> --param package:com.gyro.model.realm --param support_annotations:true --param use_wrappers:true
+```
+
+
+# Generated Code
+
+Combine options :
+
+`FidelityCard.java`:
+
+```java
+package com.gyro.model.realm;
+
+/* DO NOT EDIT | Generated by gyro */
+
+import io.realm.RealmObject;
+
+public class FidelityCard extends RealmObject {
+
+    public static final class Attributes {
+        public static final String IDENTIFIER = "identifier";
+        public static final String POINTS = "points";
+
+        private Attributes() {
+            // Hide constructor
+        }
+    }
+
+    public static final class Relationships {
+        public static final String USER = "user";
+
+        private Relationships() {
+            // Hide constructor
+        }
+    }
+
+    private short identifier;
+    @android.support.annotation.IntRange(from=0,to=255)
+    private Integer points;
+    private User user;
+
+    public short getIdentifier() {
+        return identifier;
+    }
+
+    public void setIdentifier(final short identifier) {
+        this.identifier = identifier;
+    }
+
+    @android.support.annotation.Nullable
+    @android.support.annotation.IntRange(from=0,to=255)
+    public Integer getPoints() {
+        return points;
+    }
+
+    public void setPoints(@android.support.annotation.Nullable @android.support.annotation.IntRange(from=0,to=255) final Integer points) {
+        this.points = points;
+    }
+
+    @android.support.annotation.NonNull
+    public User getUser() {
+        return user;
+    }
+
+    public void setUser(@android.support.annotation.NonNull final User user) {
+        this.user = user;
+    }
+}
+```
+
+Compare to generated code without options : 
+
+`FidelityCard.java`:
+
+```java
+/* DO NOT EDIT | Generated by gyro */
+
+import io.realm.RealmObject;
+import io.realm.annotations.PrimaryKey;
+
+public class Product extends RealmObject {
+
+    public static final class Attributes {
+        public static final String BRAND = "brand";
+        public static final String NAME = "name";
+        public static final String PRICE = "price";
+
+        private Attributes() {
+            // Hide constructor
+        }
+    }
+
+    private String brand;
+    @PrimaryKey
+    private String name;
+    private int price;
+
+    public String getBrand() {
+        return brand;
+    }
+
+    public void setBrand(final String brand) {
+        this.brand = brand;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(final String name) {
+        this.name = name;
+    }
+
+    public int getPrice() {
+        return price;
+    }
+
+    public void setPrice(final int price) {
+        this.price = price;
+    }
+}
+```

data/lib/templates/android/entity.liquid

@@ -0,0 +1,49 @@
+{%- if params.package.size > 0 -%}
+package {{ params.package }};
+{%- endif %}
+
+/* DO NOT EDIT | Generated by gyro */
+{{ empty_line }}
+{%- if entity.has_json_key_path == true %}
+import com.google.gson.annotations.SerializedName;
+{% comment %} *** Empty line *** {% endcomment %}
+{%- endif %}
+{%- if entity.has_date_attribute == true %}
+import java.util.Date;
+{%- endif %}
+{%- if entity.has_list_relationship == true %}
+import java.util.List;
+{%- endif %}
+{%- if entity.has_date_attribute == true or entity.has_list_relationship == true %}
+{{ empty_line }}
+{%- endif %}
+{%- if entity.has_list_attributes == true %}
+import io.realm.RealmList;
+{%- endif %}
+import io.realm.RealmObject;
+{%- if entity.has_ignored == true %}
+import io.realm.annotations.Ignore;
+{%- endif %}
+{%- if entity.has_indexed_attributes == true %}
+import io.realm.annotations.Index;
+{%- endif %}
+{%- if entity.has_primary_key == true %}
+import io.realm.annotations.PrimaryKey;
+{%- endif %}
+
+{% if entity.comment.size > 0 -%}
+/**
+ * {{ entity.comment }}
+ */
+{% endif %}
+{%- assign primary_key = entity.identity_attribute -%}
+public class {{ entity.name }} extends RealmObject {
+
+    {%- include 'inc/attributes_enum' %}
+    {%- include 'inc/relationships_enum' %}
+    {% include 'inc/attributes_properties' %}
+    {%- include 'inc/relationships_properties' %}
+    {%- include 'inc/attributes_getter_setter' %}
+    {%- include 'inc/relationships_getter_setter' %}
+    {%- include 'inc/enum_getter_setter' %}
+}