gris 0.0.2

data/gris.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/gris/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'gris'
+  s.version     = Gris::VERSION
+  s.summary     = 'A simple api microservice generator.'
+  s.description = 'Gris is a generator for Grape, Roar, Hypermedia, PG API apps.'
+  s.email       = 'email@dylanfareed.com'
+  s.homepage    = 'http://github.com/dylanfareed/gris/'
+  s.authors     = ['Dylan Fareed']
+  s.licenses    = 'MIT-LICENSE'
+
+  s.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  s.executables   << 'gris'
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.name          = 'gris'
+  s.require_paths = ['lib']
+  s.required_ruby_version = '>= 2.1.5'
+
+  s.add_runtime_dependency 'thor', '~> 0.19', '>= 0.19.1'
+  s.add_runtime_dependency 'activesupport', '~> 4.2', '>= 4.2.0'
+  s.add_runtime_dependency 'rake', '~> 10.4', '>= 10.4.2'
+  s.add_runtime_dependency 'git', '~> 1.2', '>= 1.2.8'
+
+  s.add_dependency 'logging'
+  s.add_dependency 'dotenv', '~> 1.0.2', '>= 1.0.2'
+  s.add_dependency 'grape', '~> 0.10.1', '>= 0.10.1'
+  s.add_dependency 'grape-roar', '~> 0.3.0', '>= 0.3.0'
+
+  s.add_dependency 'grape-swagger', '~> 0.9.0', '>= 0.9.0'
+  s.add_dependency 'roar', '~> 1.0.0', '>= 1.0.0'
+  s.add_dependency 'racksh', '~> 1.0'
+
+  s.add_development_dependency 'bundler', '~> 1.7.10', '>= 1.7.10'
+  s.add_development_dependency 'rspec', '~> 3.1', '>= 3.1.0'
+  s.add_development_dependency 'rubocop', '~> 0.28', '>= 0.28.0'
+  s.add_development_dependency 'activerecord', '~> 4.2', '>= 4.2.0'
+  s.add_development_dependency 'acts_as_fu', '~> 0'
+end

data/lib/gris.rb

@@ -0,0 +1,37 @@
+# require external libraries
+require 'rake'
+require 'dotenv'
+require 'yaml'
+require 'grape'
+require 'json'
+require 'roar'
+require 'grape-roar'
+require 'roar/representer'
+require 'roar/json'
+require 'roar/json/hal'
+
+# require internal files
+require 'gris/deprecations'
+require 'gris/grape_extensions/crud_helpers'
+require 'gris/identity'
+require 'gris/middleware/app_monitor'
+require 'gris/output_formatters/paginated_presenter'
+require 'gris/output_formatters/presenter'
+require 'gris/setup'
+require 'gris/version'
+
+# load rake tasks if Rake installed
+if defined?(Rake)
+  load 'tasks/routes.rake'
+  load 'tasks/db.rake'
+end
+
+module Gris
+  class << self
+    def initialize
+      Gris::Deprecations.initialization_checks
+    end
+  end
+end
+
+Gris.initialize

data/lib/gris/cli.rb

@@ -0,0 +1,71 @@
+require 'thor'
+require 'gris/generators'
+require 'gris/version'
+
+Gris.load_environment if defined?(Dotenv)
+
+module Gris
+  class CLI
+    class Generate < Thor
+      register(
+        Generators::ApiGenerator,
+        'api',
+        'api <api_name>',
+        'Create a Grape API, Model and Presenter'
+      )
+
+      register(
+        Generators::MigrationGenerator,
+        'migration',
+        'migration <migration_name> [field[:type][:index] field[:type][:index]]',
+        'Create a Database Migration'
+      )
+    end
+  end
+  class CLI
+    class Base < Thor
+      desc 'version', 'Returns the Gris version number'
+      def version
+        say Gris::VERSION
+      end
+
+      desc 'console [environment]', 'Start the Gris console'
+      options aliases: 'c'
+      def console(environment = nil)
+        ENV['RACK_ENV'] = environment || 'development'
+
+        require 'racksh/init'
+
+        begin
+          require 'pry'
+          interpreter = Pry
+        rescue LoadError
+          require 'irb'
+          require 'irb/completion'
+          interpreter = IRB
+          # IRB uses ARGV and does not expect these arguments.
+          ARGV.delete('console')
+          ARGV.delete(environment) if environment
+        end
+
+        Rack::Shell.init
+
+        $0 = "#{$PROGRAM_NAME} console"
+        interpreter.start
+      end
+
+      register(
+        Generators::ScaffoldGenerator,
+        'new',
+        'new <app_name> [app_path]',
+        'Creates a scaffold for a new Gris service'
+      )
+
+      desc 'generate api <api_name>', 'Create a Grape API, Model and Representer'
+      subcommand 'generate api', Gris::CLI::Generate
+
+      desc 'generate migration <migration_name> [field[:type][:index] field[:type][:index]]', 'Create a Database Migration'
+      subcommand 'generate', Gris::CLI::Generate
+    end
+  end
+end

data/lib/gris/deprecations.rb

@@ -0,0 +1,9 @@
+require 'gris/deprecations/gris_setup'
+
+module Gris
+  class Deprecations
+    def self.initialization_checks
+      gris_setup_check
+    end
+  end
+end

data/lib/gris/deprecations/gris_setup.rb

@@ -0,0 +1,14 @@
+module Gris
+  class Deprecations
+    # TODO: Called when Gris appliation loads.
+    #
+    # Use this method to check that embedding applications
+    # follow current established best practices.
+    # cf. https://github.com/bellycard/napa/blob/master/lib/napa/deprecations.rb
+    # https://github.com/bellycard/napa/blob/master/lib/napa/deprecations/napa_setup.rb
+    # https://github.com/bellycard/napa/blob/master/lib/napa/deprecations/application_api.rb
+    #
+    def self.gris_setup_check
+    end
+  end
+end

data/lib/gris/generators.rb

@@ -0,0 +1,3 @@
+require 'gris/generators/api_generator'
+require 'gris/generators/migration_generator'
+require 'gris/generators/scaffold_generator'

data/lib/gris/generators/api_generator.rb

@@ -0,0 +1,31 @@
+require 'thor'
+require 'active_support/all'
+
+module Gris
+  module Generators
+    class ApiGenerator < Thor::Group
+      include Thor::Actions
+      argument :name
+
+      def name_underscore
+        name.underscore
+      end
+
+      def name_tableize
+        name.tableize
+      end
+
+      def output_directory
+        '.'
+      end
+
+      def api
+        self.class.source_root "#{File.dirname(__FILE__)}/templates/api"
+        say 'Generating api...'
+        directory '.', output_directory
+        say 'API files created!', :green
+        say 'Note that you will need to mount this new endpoint in your ApplicationEndpoint.', :green
+      end
+    end
+  end
+end

data/lib/gris/generators/migration_generator.rb

@@ -0,0 +1,228 @@
+require 'thor'
+require 'active_support/all'
+
+module Gris
+  module Generators
+    class MigrationGenerator < Thor::Group
+      include Thor::Actions
+      # largely ported over, with a few differences, from
+      # https://github.com/rails/rails/blob/76883f92374c6395f13c16628e1d87d40b6d2399/activerecord/lib/rails/generators/active_record/migration/migration_generator.rb
+      argument :migration_name
+      argument :attributes, type: :array, default: []
+
+      attr_reader :migration_action, :join_tables, :table_name
+
+      def version
+        Time.now.utc.strftime('%Y%m%d%H%M%S')
+      end
+
+      def migration_filename
+        "#{version}_#{migration_name.underscore}"
+      end
+
+      def output_directory
+        './db/migrate'
+      end
+
+      def parse_attributes!
+        self.attributes = (attributes || []).map do |attr|
+          GeneratedAttribute.parse(attr)
+        end
+      end
+
+      def set_local_assigns!
+        @migration_template = 'migration'
+        filename = migration_name.underscore
+        case filename
+        when /^(add|remove)_.*_(?:to|from)_(.*)/
+          @migration_action = Regexp.last_match[1]
+          @table_name       = Regexp.last_match[2].pluralize
+        when /join_table/
+          if attributes.length == 2
+            @migration_action = 'join'
+            @join_tables      = attributes.map(&:plural_name)
+
+            set_index_names
+          end
+        when /^create_(.+)/
+          @table_name = Regexp.last_match[1].pluralize
+          @migration_template = 'create_table_migration'
+        end
+      end
+
+      def migration
+        self.class.source_root "#{File.dirname(__FILE__)}/templates/#{@migration_template}"
+        say 'Generating migration...'
+        directory '.', output_directory
+        say 'Done!', :green
+      end
+
+      private
+
+      def attributes_with_index
+        attributes.select { |a| !a.reference? && a.has_index? }
+      end
+
+      def set_index_names
+        attributes.each_with_index do |attr, i|
+          attr.index_name = [attr, attributes[i - 1]].map { |a| index_name_for(a) }
+        end
+      end
+
+      def index_name_for(attribute)
+        if attribute.foreign_key?
+          attribute.name
+        else
+          attribute.name.singularize.foreign_key
+        end.to_sym
+      end
+    end
+
+    # directly ported from
+    # https://github.com/rails/rails/blob/76883f92374c6395f13c16628e1d87d40b6d2399/railties/lib/rails/generators/generated_attribute.rb
+    class GeneratedAttribute # :nodoc:
+      INDEX_OPTIONS = %w(index uniq)
+      UNIQ_INDEX_OPTIONS = %w(uniq)
+
+      attr_accessor :name, :type
+      attr_reader :attr_options
+      attr_writer :index_name
+
+      class << self
+        def parse(column_definition)
+          name, type, has_index = column_definition.split(':')
+
+          # if user provided "name:index" instead of "name:string:index"
+          # type should be set blank so GeneratedAttribute's constructor
+          # could set it to :string
+          has_index, type = type, nil if INDEX_OPTIONS.include?(type)
+
+          type, attr_options = *parse_type_and_options(type)
+          type = type.to_sym if type
+
+          if type && reference?(type)
+            references_index = UNIQ_INDEX_OPTIONS.include?(has_index) ? { unique: true } : true
+            attr_options[:index] = references_index
+          end
+
+          new(name, type, has_index, attr_options)
+        end
+
+        def reference?(type)
+          [:references, :belongs_to].include? type
+        end
+
+        private
+
+        # parse possible attribute options like :limit for string/text/binary/integer, :precision/:scale for decimals or :polymorphic for references/belongs_to
+        # when declaring options curly brackets should be used
+        def parse_type_and_options(type)
+          case type
+          when /(string|text|binary|integer)\{(\d+)\}/
+            return Regexp.last_match[1], limit: Regexp.last_match[2].to_i
+          when /decimal\{(\d+)[,.-](\d+)\}/
+            return :decimal, precision: Regexp.last_match[1].to_i, scale: Regexp.last_match[2].to_i
+          when /(references|belongs_to)\{polymorphic\}/
+            return Regexp.last_match[1], polymorphic: true
+          else
+            return type, {}
+          end
+        end
+      end
+
+      def initialize(name, type = nil, index_type = false, attr_options = {})
+        @name           = name
+        @type           = type || :string
+        @has_index      = INDEX_OPTIONS.include?(index_type)
+        @has_uniq_index = UNIQ_INDEX_OPTIONS.include?(index_type)
+        @attr_options   = attr_options
+      end
+
+      def field_type
+        @field_type ||= case type
+          when :integer              then :number_field
+          when :float, :decimal      then :text_field
+          when :time                 then :time_select
+          when :datetime, :timestamp then :datetime_select
+          when :date                 then :date_select
+          when :text                 then :text_area
+          when :boolean              then :check_box
+          else
+            :text_field
+        end
+      end
+
+      def default
+        @default ||= case type
+          when :integer                     then 1
+          when :float                       then 1.5
+          when :decimal                     then '9.99'
+          when :datetime, :timestamp, :time then Time.now.to_s(:db)
+          when :date                        then Date.today.to_s(:db)
+          when :string                      then name == 'type' ? '' : 'MyString'
+          when :text                        then 'MyText'
+          when :boolean                     then false
+          when :references, :belongs_to     then nil
+          else
+            ''
+        end
+      end
+
+      def plural_name
+        name.sub(/_id$/, '').pluralize
+      end
+
+      def singular_name
+        name.sub(/_id$/, '').singularize
+      end
+
+      def human_name
+        name.humanize
+      end
+
+      def index_name
+        @index_name ||= if polymorphic?
+                          %w(id type).map { |t| "#{name}_#{t}" }
+                        else
+                          column_name
+        end
+      end
+
+      def column_name
+        @column_name ||= reference? ? "#{name}_id" : name
+      end
+
+      def foreign_key?
+        !!(name =~ /_id$/)
+      end
+
+      def reference?
+        self.class.reference?(type)
+      end
+
+      def polymorphic?
+        attr_options.key?(:polymorphic)
+      end
+
+      def has_index?
+        @has_index
+      end
+
+      def has_uniq_index?
+        @has_uniq_index
+      end
+
+      def password_digest?
+        name == 'password' && type == :digest
+      end
+
+      def inject_options
+        ''.tap { |s| @attr_options.each { |k, v| s << ", #{k}: #{v.inspect}" } }
+      end
+
+      def inject_index_options
+        has_uniq_index? ? ', unique: true' : ''
+      end
+    end
+  end
+end

data/lib/gris/generators/scaffold_generator.rb

@@ -0,0 +1,21 @@
+require 'thor'
+require 'active_support/core_ext/string'
+
+module Gris
+  module Generators
+    class ScaffoldGenerator < Thor::Group
+      include Thor::Actions
+
+      source_root "#{File.dirname(__FILE__)}/templates/scaffold"
+
+      argument :app_name
+      argument :app_path, optional: true
+
+      def generate
+        say 'Generating scaffold...'
+        directory '.', (app_path || app_name)
+        say 'Done!', :green
+      end
+    end
+  end
+end