grape-starter 0.2.0

data/lib/starter/builder/names.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+module Starter
+  module Names
+    def klass_name
+      for_klass = prepare_klass
+      singular? ? for_klass.classify : for_klass.classify.pluralize
+    end
+
+    def base_file_name
+      @resource.tr('/', '-').downcase + '.rb'
+    end
+
+    def base_spec_name
+      base_file_name.gsub(/.rb$/, '_spec.rb')
+    end
+
+    def api_base_file_name
+      File.join(Dir.getwd, 'api', 'base.rb')
+    end
+
+    # resource file
+    def api_file_name
+      File.join(Dir.getwd, 'api', 'endpoints', base_file_name)
+    end
+
+    # resource file
+    def entity_file_name
+      File.join(Dir.getwd, 'api', 'entities', base_file_name)
+    end
+
+    # lib file
+    def lib_file_name
+      File.join(Dir.getwd, 'lib', 'api', base_file_name)
+    end
+
+    # resource spec
+    def api_spec_name
+      File.join(Dir.getwd, 'spec', 'requests', base_spec_name)
+    end
+
+    # lib spec
+    def lib_spec_name
+      File.join(Dir.getwd, 'spec', 'lib', 'api', base_spec_name)
+    end
+
+    private
+
+    def prepare_klass
+      @resource.tr('-', '/')
+    end
+
+    def singular?
+      @resource.singularize.inspect == @resource.inspect
+    end
+  end
+end

data/lib/starter/builder/template_endpoints.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+module Starter
+  module Template
+    # defining the endpoints -> http methods of a resource
+    module Endpoints
+      def crud
+        %i(
+          post
+          get_all
+          get_specific
+          put_specific
+          patch_specific
+          delete_specific
+        )
+      end
+
+      def singular_one
+        %i(
+          post
+          get_one
+          put_one
+          patch_one
+          delete_one
+        )
+      end
+
+      # available API/HTTP methods
+      # POST
+      def post
+        "
+        desc 'create #{resource.singularize}'
+        params do
+          # TODO: specify the parameters
+        end
+        post do
+          # your code goes here
+        end"
+      end
+
+      # GET
+      def get_all
+        "
+        desc 'get all of #{resource.pluralize}',
+        is_array: true
+        get do
+          # your code goes here
+        end"
+      end
+
+      %w(get put patch delete).each do |verb|
+        define_method(:"#{verb}_one") do
+          "
+          desc '#{verb} #{resource.singularize}'
+          #{verb} do
+            # your code goes here
+          end"
+        end
+      end
+
+      %w(get put patch delete).each do |verb|
+        define_method(:"#{verb}_specific") do
+          "
+          desc '#{verb} specific #{resource.singularize}'
+          params do
+            requires :id
+          end
+          #{verb} ':id' do
+            # your code goes here
+            present :params, params
+          end"
+        end
+      end
+
+      # request specs shared examples
+      #
+      def post_spec
+        "it_behaves_like 'POST', base_path: '/api/v1', resource: '#{resource}'"
+      end
+
+      def get_all_spec
+        "it_behaves_like 'GET all', base_path: '/api/v1', resource: '#{resource}'"
+      end
+
+      %w(get put patch delete).each do |verb|
+        define_method(:"#{verb}_one_spec") do
+          "it_behaves_like '#{verb.upcase} one', base_path: '/api/v1', resource: '#{resource}'"
+        end
+      end
+
+      %w(get put patch delete).each do |verb|
+        define_method(:"#{verb}_specific_spec") do
+          "it_behaves_like '#{verb.upcase} specific', base_path: '/api/v1', resource: '#{resource}', key: 1"
+        end
+      end
+    end
+  end
+end

data/lib/starter/builder/template_files.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+require 'active_support/core_ext/string'
+
+module Starter
+  module Template
+    module Files
+      # API template for resource
+      def api_file
+        <<-FILE.strip_heredoc
+        # frozen_string_literal: true
+
+        module Api
+          module Endpoints
+            class #{klass_name} < Grape::API
+              namespace :#{resource.downcase} do
+                #{endpoints}
+              end
+            end
+          end
+        end
+        FILE
+      end
+
+      def entity_file
+        <<-FILE.strip_heredoc
+        # frozen_string_literal: true
+
+        module Api
+          module Entities
+            class #{klass_name} < Grape::Entity
+            end
+          end
+        end
+        FILE
+      end
+
+      # LIB template for resource
+      def lib_file
+        <<-FILE.strip_heredoc
+        # frozen_string_literal: true
+
+        module Api
+          class #{klass_name}
+          end
+        end
+        FILE
+      end
+
+      def api_spec
+        <<-FILE.strip_heredoc
+        # frozen_string_literal: true
+        require 'spec_helper'
+
+        RSpec.describe Api::#{klass_name} do
+          pending 'write specs'
+          #{endpoint_specs}
+        end
+        FILE
+      end
+
+      def lib_spec
+        <<-FILE.strip_heredoc
+        # frozen_string_literal: true
+        require 'spec_helper'
+
+        RSpec.describe Api::#{klass_name} do
+          pending 'write specs'
+        end
+        FILE
+      end
+    end
+  end
+end

data/lib/starter/rake/grape_tasks.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+require 'rake'
+require 'rake/tasklib'
+require 'rack/test'
+
+module Starter
+  module Rake
+    require 'starter/builder'
+
+    class GrapeTasks < ::Rake::TaskLib
+      include Rack::Test::Methods
+
+      attr_reader :resource
+      attr_reader :api_class
+
+      def initialize(api_class = nil)
+        super()
+
+        @api_class = api_class
+        define_tasks
+      end
+
+      def api_routes
+        api_class.routes.each_with_object([]) do |route, memo|
+          memo << { verb: route.request_method, path: build_path(route), description: route.description }
+        end
+      end
+
+      private
+
+      def define_tasks
+        routes
+      end
+
+      # gets all api routes
+      def routes
+        desc 'shows all routes'
+        task routes: :environment do
+          print_routes api_routes
+        end
+      end
+
+      # helper methods
+      #
+      def print_routes(routes_array)
+        routes_array.each do |route|
+          puts "\t#{route[:verb].ljust(7)}#{route[:path].ljust(42)}#{route[:description]}"
+        end
+      end
+
+      def build_path(route)
+        path = route.path
+
+        path.sub!(/\(\.\w+?\)$/, '')
+        path.sub!('(.:format)', '')
+
+        if route.version
+          path.sub!(':version', route.version.to_s)
+        else
+          path.sub!('/:version', '')
+        end
+
+        path
+      end
+
+      def app
+        api_class.new
+      end
+    end
+  end
+end

data/lib/starter/rspec/request_specs.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+# CRUD examples
+#
+# for single
+RSpec.shared_examples 'single CRUD' do |base_path: '/api/v1', resource: ''|
+  it_behaves_like 'POST', base_path: base_path, resource: resource
+  it_behaves_like 'GET one', base_path: base_path, resource: resource
+  it_behaves_like 'PUT one', base_path: base_path, resource: resource
+  it_behaves_like 'PATCH one', base_path: base_path, resource: resource
+  it_behaves_like 'DELETE one', base_path: base_path, resource: resource
+end
+#
+# for plural
+RSpec.shared_examples 'plural CRUD' do |base_path: '/api/v1', resource: '', key: nil|
+  it_behaves_like 'POST', base_path: base_path, resource: resource
+  it_behaves_like 'GET all', base_path: base_path, resource: resource
+  it_behaves_like 'GET specific', base_path: base_path, resource: resource, key: key
+  it_behaves_like 'PUT specific', base_path: base_path, resource: resource, key: key
+  it_behaves_like 'PATCH specific', base_path: base_path, resource: resource, key: key
+  it_behaves_like 'DELETE specific', base_path: base_path, resource: resource, key: key
+end
+
+# singular forms
+#
+RSpec.shared_examples 'POST' do |base_path: '/api/v1', resource: ''|
+  let(:route) { "#{base_path}/#{resource}" }
+
+  subject { post route }
+  specify { expect(subject.status).to eql 201 }
+end
+
+RSpec.shared_examples 'GET one' do |base_path: '/api/v1', resource: ''|
+  let(:route) { "#{base_path}/#{resource}" }
+
+  subject { get route }
+  specify { expect(subject.status).to eql 200 }
+end
+
+RSpec.shared_examples 'PUT one' do |base_path: '/api/v1', resource: ''|
+  let(:route) { "#{base_path}/#{resource}" }
+
+  subject { put route }
+  specify { expect(subject.status).to eql 200 }
+end
+
+RSpec.shared_examples 'PATCH one' do |base_path: '/api/v1', resource: ''|
+  let(:route) { "#{base_path}/#{resource}" }
+
+  subject { patch route }
+  specify { expect(subject.status).to eql 200 }
+end
+
+RSpec.shared_examples 'DELETE one' do |base_path: '/api/v1', resource: ''|
+  let(:route) { "#{base_path}/#{resource}" }
+
+  subject { delete route }
+  specify { expect(subject.status).to eql 204 }
+end
+
+# plural forms
+#
+RSpec.shared_examples 'POST' do |base_path: '/api/v1', resource: '', key: nil|
+  let(:route) { "#{base_path}/#{resource}" }
+  let(:specific_route) { "#{route}/#{key}" }
+
+  subject { post route }
+  specify { expect(subject.status).to eql 201 }
+end
+
+RSpec.shared_examples 'GET all' do |base_path: '/api/v1', resource: '', key: nil|
+  let(:route) { "#{base_path}/#{resource}" }
+  let(:specific_route) { "#{route}/#{key}" }
+
+  subject { get route }
+  specify { expect(subject.status).to eql 200 }
+end
+
+RSpec.shared_examples 'GET specific' do |base_path: '/api/v1', resource: '', key: nil|
+  let(:route) { "#{base_path}/#{resource}" }
+  let(:specific_route) { "#{route}/#{key}" }
+
+  subject { get specific_route }
+  specify { expect(subject.status).to eql 200 }
+end
+
+RSpec.shared_examples 'PUT specific' do |base_path: '/api/v1', resource: '', key: nil|
+  let(:route) { "#{base_path}/#{resource}" }
+  let(:specific_route) { "#{route}/#{key}" }
+
+  subject { put specific_route }
+  specify { expect(subject.status).to eql 200 }
+end
+
+RSpec.shared_examples 'PATCH specific' do |base_path: '/api/v1', resource: '', key: nil|
+  let(:route) { "#{base_path}/#{resource}" }
+  let(:specific_route) { "#{route}/#{key}" }
+
+  subject { patch specific_route }
+  specify { expect(subject.status).to eql 200 }
+end
+
+RSpec.shared_examples 'DELETE specific' do |base_path: '/api/v1', resource: '', key: nil|
+  let(:route) { "#{base_path}/#{resource}" }
+  let(:specific_route) { "#{route}/#{key}" }
+
+  subject { delete specific_route }
+  specify { expect(subject.status).to eql 204 }
+end

data/lib/starter/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Starter
+  VERSION = '0.2.0'
+end

data/template/.rubocop.yml

@@ -0,0 +1,15 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - '**/tmp/**/*'
+    - '**/script/**/*'
+  UseCache: true
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Exclude:
+    - 'api/endpoints/**/*'
+
+Metrics/LineLength:
+  Max: 120

data/template/.rubocop_todo.yml

@@ -0,0 +1,28 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-10-18 20:40:59 +0200 using RuboCop version 0.44.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 120
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 10
+
+Style/AsciiComments:
+  Enabled: false
+
+# Offense count: 6
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'api/**/*'
+    - 'lib/**/*'