grape-starter 1.5.1 → 1.6.0

data/lib/starter/builder/templates/endpoints.rb

@@ -1,117 +1,119 @@
 # frozen_string_literal: true
 
 module Starter
-  module Templates
-    # 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}' do
-          tags %w[#{resource.singularize}]
+  module Builder
+    module Templates
+      # 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
-        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}' do
-          is_array true
-          tags %w[#{resource.singularize}]
+        def singular_one
+          %i[
+            post
+            get_one
+            put_one
+            patch_one
+            delete_one
+          ]
         end
-        get do
-          # your code goes here
-        end"
-      end
 
-      # rubocop:disable Style/CombinableLoops
-      %w[get put patch delete].each do |verb|
-        define_method(:"#{verb}_one") do
+        # available API/HTTP methods
+        # POST
+        def post
           "
-          desc '#{verb} #{resource.singularize}' do
+          desc 'create #{resource.singularize}' do
             tags %w[#{resource.singularize}]
           end
-          #{verb} do
+          params do
+            # TODO: specify the parameters
+          end
+          post do
             # your code goes here
           end"
         end
-      end
 
-      %w[get put patch delete].each do |verb|
-        define_method(:"#{verb}_specific") do
+        # GET
+        def get_all
           "
-          desc '#{verb} specific #{resource.singularize}' do
+          desc 'get all of #{resource.pluralize}' do
+            is_array true
             tags %w[#{resource.singularize}]
           end
-          params do
-            requires :id
-          end
-          #{verb} ':id' do
+          get do
             # your code goes here
           end"
         end
-      end
-      # rubocop:enable Style/CombinableLoops
 
-      # request specs shared examples
-      #
-      def post_spec
-        "it_behaves_like 'POST', params: {}"
-      end
+        # rubocop:disable Style/CombinableLoops
+        %w[get put patch delete].each do |verb|
+          define_method(:"#{verb}_one") do
+            "
+            desc '#{verb} #{resource.singularize}' do
+              tags %w[#{resource.singularize}]
+            end
+            #{verb} do
+              # your code goes here
+            end"
+          end
+        end
 
-      def get_all_spec
-        "it_behaves_like 'GET all'"
-      end
+        %w[get put patch delete].each do |verb|
+          define_method(:"#{verb}_specific") do
+            "
+            desc '#{verb} specific #{resource.singularize}' do
+              tags %w[#{resource.singularize}]
+            end
+            params do
+              requires :id
+            end
+            #{verb} ':id' do
+              # your code goes here
+            end"
+          end
+        end
+        # rubocop:enable Style/CombinableLoops
 
-      %w[get delete].each do |verb|
-        define_method(:"#{verb}_one_spec") do
-          "it_behaves_like '#{verb.upcase} one'"
+        # request specs shared examples
+        #
+        def post_spec
+          "it_behaves_like 'POST', params: {}"
         end
-      end
 
-      %w[put patch].each do |verb|
-        define_method(:"#{verb}_one_spec") do
-          "it_behaves_like '#{verb.upcase} one', params: {}"
+        def get_all_spec
+          "it_behaves_like 'GET all'"
         end
-      end
 
-      %w[get delete].each do |verb|
-        define_method(:"#{verb}_specific_spec") do
-          "it_behaves_like '#{verb.upcase} specific', key: 1"
+        %w[get delete].each do |verb|
+          define_method(:"#{verb}_one_spec") do
+            "it_behaves_like '#{verb.upcase} one'"
+          end
         end
-      end
 
-      %w[put patch].each do |verb|
-        define_method(:"#{verb}_specific_spec") do
-          "it_behaves_like '#{verb.upcase} specific', key: 1, params: {}"
+        %w[put patch].each do |verb|
+          define_method(:"#{verb}_one_spec") do
+            "it_behaves_like '#{verb.upcase} one', params: {}"
+          end
+        end
+
+        %w[get delete].each do |verb|
+          define_method(:"#{verb}_specific_spec") do
+            "it_behaves_like '#{verb.upcase} specific', key: 1"
+          end
+        end
+
+        %w[put patch].each do |verb|
+          define_method(:"#{verb}_specific_spec") do
+            "it_behaves_like '#{verb.upcase} specific', key: 1, params: {}"
+          end
         end
       end
     end

data/lib/starter/builder/templates/files.rb

@@ -1,83 +1,85 @@
 # frozen_string_literal: true
 
 module Starter
-  module Templates
-    module Files
-      # API template for resource
-      def api_file
-        <<-FILE.strip_heredoc
-        # frozen_string_literal: true
+  module Builder
+    module Templates
+      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}
+          module Api
+            module Endpoints
+              class #{klass_name} < Grape::API
+                namespace :#{resource.downcase} do
+                  #{endpoints}
+                end
               end
             end
           end
+          FILE
         end
-        FILE
-      end
 
-      def entity_file
-        <<-FILE.strip_heredoc
-        # frozen_string_literal: true
+        def entity_file
+          <<-FILE.strip_heredoc
+          # frozen_string_literal: true
 
-        module Api
-          module Entities
-            class #{klass_name} < Grape::Entity
+          module Api
+            module Entities
+              class #{klass_name} < Grape::Entity
+              end
             end
           end
+          FILE
         end
-        FILE
-      end
 
-      # LIB template for resource
-      def base_namespace_file
-        <<-FILE.strip_heredoc
-        # frozen_string_literal: true
+        # LIB template for resource
+        def base_namespace_file
+          <<-FILE.strip_heredoc
+          # frozen_string_literal: true
 
-        module #{klass_name}
-          VERSION  = '0.1.0'
+          module #{klass_name}
+            VERSION  = '0.1.0'
+          end
+          FILE
         end
-        FILE
-      end
 
-      def lib_file
-        <<-FILE.strip_heredoc
-        # frozen_string_literal: true
+        def lib_file
+          <<-FILE.strip_heredoc
+          # frozen_string_literal: true
 
-        module Models
-          class #{lib_klass_name}
+          module Models
+            class #{lib_klass_name}
+            end
           end
+          FILE
         end
-        FILE
-      end
 
-      def api_spec
-        prefix = base_prefix ? "/#{base_prefix}" : ''
-        <<-FILE.strip_heredoc
-        # frozen_string_literal: true
+        def api_spec
+          prefix = base_prefix ? "/#{base_prefix}" : ''
+          <<-FILE.strip_heredoc
+          # frozen_string_literal: true
 
-        require 'spec_helper'
+          require 'spec_helper'
 
-        RSpec.describe '#{prefix}/#{base_version}/#{resource.downcase}' do
-          #{endpoint_specs}
+          RSpec.describe '#{prefix}/#{base_version}/#{resource.downcase}' do
+            #{endpoint_specs}
+          end
+          FILE
         end
-        FILE
-      end
 
-      def lib_spec
-        <<-FILE.strip_heredoc
-        # frozen_string_literal: true
+        def lib_spec
+          <<-FILE.strip_heredoc
+          # frozen_string_literal: true
 
-        require 'spec_helper'
+          require 'spec_helper'
 
-        RSpec.describe Models::#{klass_name} do
-          pending 'write specs'
+          RSpec.describe Models::#{klass_name} do
+            pending 'write specs'
+          end
+          FILE
         end
-        FILE
       end
     end
   end

data/lib/starter/builder/templates/sequel.rb

@@ -1,105 +1,107 @@
 # frozen_string_literal: true
 
 module Starter
-  module Templates
-    module Sequel
-      def model_klass
-        'Sequel::Model'
-      end
+  module Builder
+    module Templates
+      module Sequel
+        def model_klass
+          'Sequel::Model'
+        end
 
-      def initializer
-        <<-FILE.strip_heredoc
-        # frozen_string_literal: true
+        def initializer
+          <<-FILE.strip_heredoc
+          # frozen_string_literal: true
 
-        require 'yaml'
+          require 'yaml'
 
-        # load Sequel Configuration
-        settings = YAML.load_file('config/database.yml')
-        DB = Sequel.connect(settings[ENV['RACK_ENV']])
+          # load Sequel Configuration
+          settings = YAML.load_file('config/database.yml')
+          DB = Sequel.connect(settings[ENV['RACK_ENV']])
 
-        env = ENV['RACK_ENV'] || 'development'
+          env = ENV['RACK_ENV'] || 'development'
 
-        logger = if %w[development test].include? env
-                   log_dir = File.join(Dir.getwd, 'log')
-                   log_file = File.join(log_dir, 'db.log')
-                   FileUtils.mkdir(log_dir) unless Dir.exist?(log_dir)
-                   Logger.new(File.open(log_file, 'a'))
-                 else
-                   Logger.new($stdout)
-                 end
+          logger = if %w[development test].include? env
+                    log_dir = File.join(Dir.getwd, 'log')
+                    log_file = File.join(log_dir, 'db.log')
+                    FileUtils.mkdir(log_dir) unless Dir.exist?(log_dir)
+                    Logger.new(File.open(log_file, 'a'))
+                  else
+                    Logger.new($stdout)
+                  end
 
-        DB.loggers << logger
+          DB.loggers << logger
 
-        # FIXME: maybe remove it later …
-        #   see: https://groups.google.com/forum/#!topic/sequel-talk/QIIv5qoltjs
-        Sequel::Model.require_valid_table = false
-        Sequel::Model.plugin :force_encoding, 'UTF-8'
-        FILE
-      end
+          # FIXME: maybe remove it later …
+          #   see: https://groups.google.com/forum/#!topic/sequel-talk/QIIv5qoltjs
+          Sequel::Model.require_valid_table = false
+          Sequel::Model.plugin :force_encoding, 'UTF-8'
+          FILE
+        end
 
-      def rakefile
-        <<-FILE.strip_heredoc
-        # Sequel migration tasks
-        namespace :db do
-          Sequel.extension(:migration)
+        def rakefile
+          <<-FILE.strip_heredoc
+          # Sequel migration tasks
+          namespace :db do
+            Sequel.extension(:migration)
 
-          desc "Prints current schema version"
-          task version: :connect do
-            version = DB.tables.include?(:schema_info) ? DB[:schema_info].first[:version] : 0
+            desc "Prints current schema version"
+            task version: :connect do
+              version = DB.tables.include?(:schema_info) ? DB[:schema_info].first[:version] : 0
 
-            $stdout.print 'Schema Version: '
-            $stdout.puts version
-          end
+              $stdout.print 'Schema Version: '
+              $stdout.puts version
+            end
 
-          desc 'Run all migrations in db/migrations'
-          task migrate: :connect do
-            Sequel::Migrator.apply(DB, 'db/migrations')
-            Rake::Task['db:version'].execute
-          end
+            desc 'Run all migrations in db/migrations'
+            task migrate: :connect do
+              Sequel::Migrator.apply(DB, 'db/migrations')
+              Rake::Task['db:version'].execute
+            end
 
-          desc "Perform rollback to specified target or full rollback as default"
-          task :rollback, [:target] => :connect do |t, args|
-            args.with_defaults(:target => 0)
+            desc "Perform rollback to specified target or full rollback as default"
+            task :rollback, [:target] => :connect do |t, args|
+              args.with_defaults(:target => 0)
 
-            Sequel::Migrator.run(DB, 'db/migrations', :target => args[:target].to_i)
-            Rake::Task['db:version'].execute
-          end
+              Sequel::Migrator.run(DB, 'db/migrations', :target => args[:target].to_i)
+              Rake::Task['db:version'].execute
+            end
 
-          desc "Perform migration reset (full rollback and migration)"
-          task reset: :connect do
-            Sequel::Migrator.run(DB, 'db/migrations', target: 0)
-            Sequel::Migrator.run(DB, 'db/migrations')
-            Rake::Task['db:version'].execute
-          end
+            desc "Perform migration reset (full rollback and migration)"
+            task reset: :connect do
+              Sequel::Migrator.run(DB, 'db/migrations', target: 0)
+              Sequel::Migrator.run(DB, 'db/migrations')
+              Rake::Task['db:version'].execute
+            end
 
-          task connect: :environment do
-            require './config/initializers/database'
+            task connect: :environment do
+              require './config/initializers/database'
+            end
           end
+          FILE
         end
-        FILE
-      end
 
-      def gemfile
-        <<-FILE.strip_heredoc
-        # DB stack
-        gem 'sequel'
-        gem 'pg'
-        FILE
-      end
+        def gemfile
+          <<-FILE.strip_heredoc
+          # DB stack
+          gem 'sequel'
+          gem 'pg'
+          FILE
+        end
 
-      def migration(_klass_name, resource)
-        <<-FILE.strip_heredoc
-        Sequel.migration do
-          change do
-            create_table :#{resource} do
-              primary_key :id
+        def migration(_klass_name, resource)
+          <<-FILE.strip_heredoc
+          Sequel.migration do
+            change do
+              create_table :#{resource} do
+                primary_key :id
 
-              DateTime :created_at
-              DateTime :updated_at
+                DateTime :created_at
+                DateTime :updated_at
+              end
             end
           end
+          FILE
         end
-        FILE
       end
     end
   end

data/lib/starter/{builder/file_foo.rb → file_ops.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Starter
-  class FileFoo
+  class FileOps
     class << self
       # general file stuff
       #

data/lib/starter/{builder/orms.rb → orms.rb}

@@ -61,7 +61,7 @@ module Starter
 
         file_name = "#{Time.now.strftime('%Y%m%d%H%m%S')}_create_#{klass_name.downcase}.rb"
         migration_dest = File.join(Dir.pwd, 'db', 'migrate', file_name)
-        FileFoo.write_file(migration_dest, migration(klass_name, resource))
+        FileOps.write_file(migration_dest, migration(klass_name, resource))
       end
 
       def load_orm(orm: ::Starter::Config.read[:orm])
@@ -70,10 +70,10 @@ module Starter
         case @orm
         when 'sequel'
           require 'starter/builder/templates/sequel'
-          extend(::Starter::Templates::Sequel)
+          extend(Starter::Builder::Templates::Sequel)
         when 'activerecord', 'ar'
           require 'starter/builder/templates/activerecord'
-          extend(::Starter::Templates::ActiveRecord)
+          extend(Starter::Builder::Templates::ActiveRecord)
         else
           @orm = nil
         end
@@ -87,26 +87,26 @@ module Starter
 
       def build_initializer(dest)
         FileUtils.mkdir_p(dest)
-        FileFoo.write_file(File.join(dest, 'database.rb'), initializer)
+        FileOps.write_file(File.join(dest, 'database.rb'), initializer)
       end
 
       def build_config(dest)
-        FileFoo.write_file(File.join(dest, 'database.yml'), config)
+        FileOps.write_file(File.join(dest, 'database.yml'), config)
       end
 
       def build_standalone_migrations(dest)
-        FileFoo.write_file(dest, standalone_migrations)
+        FileOps.write_file(dest, standalone_migrations)
       end
 
       # adds a middleware to config.ru
       def add_middleware(dest, middleware)
         replacement = "use #{middleware}\n\n\\1"
-        FileFoo.call!(File.join(dest, 'config.ru')) { |content| content.sub!(/^(run.+)$/, replacement) }
+        FileOps.call!(File.join(dest, 'config.ru')) { |content| content.sub!(/^(run.+)$/, replacement) }
       end
 
       def append_to_file(file_name, content)
-        original = FileFoo.read_file(file_name)
-        FileFoo.write_file(file_name, "#{original}\n\n#{content}")
+        original = FileOps.read_file(file_name)
+        FileOps.write_file(file_name, "#{original}\n\n#{content}")
       end
 
       def prepare_for_migrations(dest)

data/lib/starter/rake/grape_tasks.rb

@@ -6,8 +6,6 @@ require 'rack/test'
 
 module Starter
   module Rake
-    require 'starter/builder'
-
     class GrapeTasks < ::Rake::TaskLib
       include Rack::Test::Methods
 

data/lib/starter/rspec/request_specs.rb

@@ -45,7 +45,7 @@ RSpec.shared_examples 'DELETE one' do
   let(:route) { route_from_description }
 
   subject { delete route }
-  specify { expect(subject.status).to eql 200 }
+  specify { expect(subject.status).to eql 204 }
 end
 
 # plural forms
@@ -75,5 +75,5 @@ RSpec.shared_examples 'DELETE specific' do |key: nil|
   let(:specific_route) { "#{route_from_description}/#{key}" }
 
   subject { delete specific_route }
-  specify { expect(subject.status).to eql 200 }
+  specify { expect(subject.status).to eql 204 }
 end

data/lib/starter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Starter
-  VERSION = '1.5.1'
+  VERSION = '1.6.0'
 end

data/lib/starter.rb

@@ -5,9 +5,13 @@ require 'awesome_print'
 require 'active_support'
 require 'active_support/core_ext/string'
 
-require 'starter/version'
-require 'starter/builder'
-require 'starter/config'
+# require 'starter/version'
+# require 'starter/builder'
+# require 'starter/config'
+
+require 'zeitwerk'
+loader = Zeitwerk::Loader.for_gem
+loader.setup
 
 module Starter
   autoload :Rake, 'starter/rake/grape_tasks'

data/template/Dockerfile

@@ -13,4 +13,4 @@ RUN bundle install
 
 COPY . .
 
-CMD bundle exec thin start -p 9292 -e production --tag API-dummy --threaded
+CMD bundle exec puma --tag API-dummy

data/template/Gemfile

@@ -3,7 +3,7 @@
 source 'http://rubygems.org'
 
 # Server stuff
-gem 'thin'
+gem 'puma'
 
 gem 'rack'
 gem 'rack-cors'

data/template/Rakefile

@@ -21,8 +21,8 @@ task default: %i[spec rubocop]
 
 # grape-swagger tasks
 require 'grape-swagger/rake/oapi_tasks'
-GrapeSwagger::Rake::OapiTasks.new(::Api::Base)
+GrapeSwagger::Rake::OapiTasks.new(Api::Base)
 
 # starter tasks
 require 'starter/rake/grape_tasks'
-Starter::Rake::GrapeTasks.new(::Api::Base)
+Starter::Rake::GrapeTasks.new(Api::Base)