grapethor 0.2.0

data/lib/grapethor.rb

@@ -0,0 +1,10 @@
+require "grapethor/version"
+require "grapethor/utils/utils"
+require "grapethor/generators/new"
+require "grapethor/generators/api"
+require "grapethor/generators/endpoint"
+require "grapethor/generators/resource"
+require "grapethor/generators/cli"
+
+module Grapethor
+end

data/lib/grapethor/generators/api.rb

@@ -0,0 +1,78 @@
+require 'thor/group'
+require 'yaml'
+
+module Grapethor
+  class Api < Thor::Group
+    include Thor::Actions
+    include Grapethor::Utils
+
+    attr_reader :api_version,
+                :app_path
+
+    namespace :api
+
+    def self.exit_on_failure?
+      true
+    end
+
+    def self.source_root
+      File.join(__dir__, '..')
+    end
+
+
+    argument :version, type: :string,
+                       desc: 'API version'
+
+    class_option :path,  aliases: '-p',
+                         type: :string,
+                         default: '.',
+                         desc: 'Relative path to application directory'
+
+
+    def parse_args_and_opts
+      @api_version = version.downcase
+      @app_path    = options[:path]
+    end
+
+
+    def validate_target_app
+      unless app_dir_exists?
+        alert <<~MSG
+                Directory '#{app_path}' does not seem to be generated by Grapethor or root application directory.\n
+                Please 'cd' into application root diretory or use '--path' option.
+              MSG
+        exit
+      end
+    end
+
+
+    def create_api
+      report("Creating new API...") do
+        directory 'templates/api', app_path
+        directory "templates/api_#{app_test_framework}", app_path
+        insert_into_file "#{app_path}/api/base.rb",
+                         "\s\s\s\smount API#{api_version}::Base\n",
+                         :before => "\s\s\s\s# mount API<VERSION>::Base\n"
+      end
+    end
+
+
+    private
+
+    def app_dir_exists?
+      File.exist?("#{app_path}/api/base.rb")
+    end
+
+    def app_name
+      @app_name ||= YAML.load(File.read(CONFIG_FILENAME))['app_name']
+    end
+
+    def app_prefix
+      @app_prefix ||= YAML.load(File.read(CONFIG_FILENAME))['app_prefix']
+    end
+
+    def app_swagger?
+      @app_swagger||= YAML.load(File.read(CONFIG_FILENAME))['app_swagger']
+    end
+  end
+end

data/lib/grapethor/generators/cli.rb

@@ -0,0 +1,35 @@
+require 'thor'
+
+module Grapethor
+  class CLI < Thor
+    include Thor::Actions
+    include Grapethor::Utils
+
+    check_unknown_options!
+
+    def self.exit_on_failure?
+      true
+    end
+
+
+    desc 'version', 'Displays Grapethor version'
+    map %w[-v --version] => :version
+    def version
+      say "Grapethor #{VERSION}"
+    end
+
+
+    # register(class_name, subcommand_alias, usage_list_string, description_string, options={})
+    register(Grapethor::New, 'new', 'new NAME', 'Creates new Grape application', options)
+    commands['new'].options = Grapethor::New.class_options
+
+    register(Grapethor::Api, 'api', 'api VERSION', 'Creates new API within application', options)
+    commands['api'].options = Grapethor::Api.class_options
+
+    register(Grapethor::Endpoint, 'endpoint', 'endpoint RESOURCE [NAME]', 'Creates new Endpoint within API', options)
+    commands['endpoint'].options = Grapethor::Endpoint.class_options
+
+    register(Grapethor::Resource, 'resource', 'resource NAME', 'Creates new Resource within API', options)
+    commands['resource'].options = Grapethor::Resource.class_options
+  end
+end

data/lib/grapethor/generators/endpoint.rb

@@ -0,0 +1,168 @@
+require 'thor/group'
+require 'active_support/inflector'
+
+module Grapethor
+  class Endpoint < Thor::Group
+    include Thor::Actions
+    include Grapethor::Utils
+
+    attr_reader :api_version,
+                :app_path,
+                :end_resource,
+                :end_name,
+                :end_method,
+                :end_desc,
+                :end_params,
+                :end_query,
+                :end_query_with_params,
+                :request_path,
+                :end_query_sample,
+                :request_path_sample
+
+    namespace :endpoint
+
+    def self.exit_on_failure?
+      true
+    end
+
+    def self.source_root
+      File.join(__dir__, '..')
+    end
+
+
+    argument :resource, type: :string,
+                        desc: "Resource name"
+
+    argument :name,     type: :string,
+                        desc: 'Endpoint name',
+                        default: ""
+
+
+    class_option :path,    aliases: '-p',
+                           type: :string,
+                           default: '.',
+                           desc: 'Relative path to application directory'
+
+    class_option :version, aliases: '-v',
+                           type: :string,
+                           default: 'v1',
+                           desc: 'API version tag'
+
+    class_option :method,  aliases: '-m',
+                           type: :string,
+                           default: 'GET',
+                           enum: %w[GET POST PUT DELETE],
+                           desc: 'HTTP request method'
+
+    class_option :desc,    aliases: '-d',
+                           type: :string,
+                           default: "",
+                           desc: 'Endpoint description'
+
+    class_option :params,  aliases: '-a',
+                           type: :hash,
+                           default: {},
+                           desc: 'Request resource (path) param'
+
+    class_option :query,   aliases: '-q',
+                           type: :hash,
+                           default: {},
+                           desc: 'Request query params'
+
+
+    def parse_args_and_opts
+      @end_resource          = resource.downcase.singularize
+      @end_name              = name.downcase.singularize
+      @end_method            = options[:method].upcase
+      @end_params            = options[:params]
+      @end_query             = options[:query].map { |k, v| [k, v.downcase] }.to_h
+      @end_query_with_params = options[:params].merge(options[:query]).map { |k, v| [k, v.downcase] }.to_h
+      @api_version           = options[:version].downcase
+      @app_path              = options[:path]
+    end
+
+
+    def prepare_endpoint
+      prepare_request_path
+
+      prepare_request_path_sample
+
+      @end_desc = options[:desc].empty? ? "#{end_method} #{request_path}" : options[:desc]
+    end
+
+
+    def validate_target_api
+      unless api_version_exists?
+        alert "API version '#{api_version}' does not exist!"
+        exit
+      end
+    end
+
+
+    def create_endpoint
+      report("Creating new endpoint...") do
+        unless File.exist?("#{app_path}/api/#{api_version}/#{end_resource_plural}.rb")
+          directory "templates/endpoint/api/\%api_version\%", "#{app_path}/api/#{api_version}"
+        end
+
+        insert_into_file "#{app_path}/api/#{api_version}/#{end_resource_plural}.rb",
+                         end_content,
+                         after: "resource :#{end_resource.pluralize} do\n"
+
+        insert_into_file "#{app_path}/api/#{api_version}/base.rb",
+                         "\s\s\s\smount API#{api_version}::#{end_resource.classify.pluralize}\n",
+                         before: "\s\s\s\s# mount API#{api_version}::<ResourceOrEndpointClass>\n"
+
+        unless File.exist?("#{app_path}/#{test_dirname}/api/#{api_version}/#{end_resource_plural}_#{test_dirname}.rb")
+          directory "templates/endpoint_#{app_test_framework}", app_path
+        end
+
+        insert_into_file "#{app_path}/#{test_dirname}/api/#{api_version}/#{end_resource_plural}_#{test_dirname}.rb",
+                         end_test_content,
+                         after: "\s\s### grapethor works here ###\n"
+      end
+    end
+
+
+    private
+
+    def prepare_request_path
+      req_path = []
+      end_params.each { |k, v| req_path << ":#{k}" } unless end_params.empty?
+      req_path << "#{end_name}" unless end_name.empty?
+      @request_path = req_path.join('/')
+    end
+
+
+    def prepare_request_path_sample
+      req_path_sample = []
+      end_params.each { |k,v| req_path_sample << sample_value(v, true) } unless end_params.empty?
+      req_path_sample << "#{end_name}" unless end_name.empty?
+      @request_path_sample = req_path_sample.join('/')
+    end
+
+
+    def api_version_exists?
+      Dir.exist?("#{app_path}/api/#{api_version}")
+    end
+
+
+    def end_content
+      erb_file = File.join(__dir__, "../templates/endpoint.rb.erb")
+      erb_templates = File.read(erb_file)
+      ERB.new(erb_templates, nil, '-').result(binding)
+    end
+
+
+    def end_test_content
+      erb_file = File.join(__dir__, "../templates/endpoint_#{app_test_framework}.rb.erb")
+      erb_templates = File.read(erb_file)
+      ERB.new(erb_templates, nil, '-').result(binding)
+    end
+
+
+    def end_resource_plural
+      end_resource.pluralize
+    end
+  end
+end

data/lib/grapethor/generators/new.rb

@@ -0,0 +1,161 @@
+require 'thor/group'
+
+module Grapethor
+  class New < Thor::Group
+    include Thor::Actions
+    include Grapethor::Utils
+
+    attr_reader :app_name,
+                :app_path,
+                :app_prefix,
+                :app_server,
+                :app_test_framework,
+                :app_db,
+                :app_orm,
+                :app_license,
+                :app_copyright,
+                :app_ruby
+
+
+    namespace :new
+
+    def self.exit_on_failure?
+      true
+    end
+
+
+    def self.source_root
+      File.join(__dir__, '..')
+    end
+
+
+    argument :name, type: :string,
+                    desc: 'Application name'
+
+
+    class_option :path,      aliases: '-p',
+                             type: :string,
+                             default: '.',
+                             desc: 'Relative path to place application directory'
+
+    class_option :prefix,    aliases: '-x',
+                             type: :string,
+                             default: 'api',
+                             desc: 'Add Application URL prefix'
+
+    class_option :db,        aliases: '-d',
+                             type: :string,
+                             default: 'sqlite',
+                             enum: %w[sqlite postgresql mysql],
+                             desc: 'Use specific database'
+
+    class_option :orm,       aliases: '-o',
+                             type: :string,
+                             default: 'activerecord',
+                             enum: %w[activerecord],
+                             desc: 'Use specific ORM'
+
+    class_option :server,    aliases: '-s',
+                             type: :string,
+                             default: 'thin',
+                             enum: %w[thin],
+                             desc: 'Preconfigure web server'
+
+    class_option :test,      aliases: '-t',
+                             type: :string,
+                             default: 'minitest',
+                             enum: %w[minitest rspec],
+                             desc: 'Use specific test framework'
+
+    class_option :docker,    type: :boolean,
+                             default: true,
+                             desc: 'Use docker'
+
+    class_option :license,   aliases: '-l',
+                             type: :string,
+                             default: 'mit',
+                             enum: %w[mit apache2 freebsd newbsd gpl2 gpl3 mpl2 cddl1 epl1],
+                             desc: 'Add software license information'
+
+    class_option :copyright, aliases: '-c',
+                             type: :string,
+                             desc: 'Add copyright information within license file'
+
+    class_option :ruby,      aliases: '-r',
+                             type: :string,
+                             default: "#{RUBY_VERSION}",
+                             desc: 'Ruby version for application'
+
+    class_option :swagger,   type: :boolean,
+                             default: true,
+                             desc: 'Generate swagger documentation and install swagger-ui'
+
+
+    def parse_args_and_opts
+      @app_name           = name
+      @app_path           = options[:path]
+      @app_prefix         = options[:prefix]
+      @app_server         = options[:server]
+      @app_test_framework = options[:test]
+      @app_db             = options[:db]
+      @app_orm            = options[:orm]
+      @app_docker         = options[:docker]
+      @app_license        = options[:license]
+      @app_copyright      = options[:copyright] || "Author of #{app_name}"
+      @app_ruby           = options[:ruby]
+      @app_swagger        = options[:swagger]
+    end
+
+
+    def create_new
+      report("Creating new application...") do
+        directory 'templates/new', File.join(app_path, app_name)
+        chmod File.join(app_path, app_name, 'bin', 'console'), 0755
+        chmod File.join(app_path, app_name, 'bin', 'setup'), 0755
+        chmod File.join(app_path, app_name, 'bin', 'server'), 0755
+
+        directory "templates/#{app_db}", "#{app_path}/#{app_name}"
+
+        directory "templates/#{app_test_framework}", "#{app_path}/#{app_name}"
+
+        directory "templates/docker", "#{app_path}/#{app_name}" if app_docker?
+
+        directory "templates/license/#{app_license}", "#{app_path}/#{app_name}"
+
+        directory "templates/swagger", "#{app_path}/#{app_name}" if app_swagger?
+      end
+    end
+
+
+    private
+
+    def app_docker?
+      @app_docker
+    end
+
+
+    def app_swagger?
+      @app_swagger
+    end
+
+
+    def rspec?
+      @app_test_framework == 'rspec'
+    end
+
+
+    def app_license_link
+      {
+        mit:     '[MIT License](http://opensource.org/licenses/MIT)',
+        apache2: '[Apache-2.0 License](https://opensource.org/licenses/Apache-2.0)',
+        freebsd: '[FreeBSD License](https://opensource.org/licenses/BSD-2-Clause)',
+        newbsd:  '[New BSD License](https://opensource.org/licenses/BSD-3-Clause)',
+        gpl2:    '[GPL-3.0 License](https://opensource.org/licenses/GPL-2.0)',
+        gpl3:    '[GPL-2.0 License](https://opensource.org/licenses/GPL-3.0)',
+        mpl2:    '[MPL-2.0 License](https://opensource.org/licenses/MPL-2.0)',
+        cddl1:   '[CDDL-1.0 License](https://opensource.org/licenses/CDDL-1.0)',
+        epl1:    '[EPL-1.0 License](https://opensource.org/licenses/EPL-1.0)'
+      }[app_license.to_sym]
+    end
+  end
+end