grape-starter 1.5.2 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34ae705b1f75703766962ff10fa9a36b38cfb7c9b1673d55a37c192c638006e6
-  data.tar.gz: 8e3217a9aef0ad3aefeb45dd1441fa8b4888ce5598af2666931afa12eaf7ef4b
+  metadata.gz: 3f03aba0838fc7a1877d9628a5a0fcdd3a29eb16836c9c41b29950814c7e5e6b
+  data.tar.gz: 64b0c86ecdcca53c866f275be224efe3937eb02dca2f299e4c7d416804c2a511
 SHA512:
-  metadata.gz: d5aa8965c7fda25e74a9900be97818e142ce3d4983607a7436ed3bca1141ec7a6042c746668125f15b1a421a37e7bfdc5bef8fcbe107fccd14a93e75cf59653e
-  data.tar.gz: a7474690efa21fd3236e1686a69f211e63d706cc88e8f07a09025b1c19d65942ba7d4e0c239b4c26e0a3f40541af0bc02ac683618c568c6e29969aea56de6710
+  metadata.gz: 68c307c7b2d86729422ff90cdde27b6a46a77c52a37b8759cbe885e6e3fa547bb7e07b04c48473cc7e7591ffc77fe8a705d7c85193f6f10f93e22d9749f3baf6
+  data.tar.gz: 78dbcdbf71393a23687be2703ac207a13ad617c04148e0813e2a49df7e3241f8a1f6d32ba3c9b3dd4865e826ee358c242c9310da424a6e32b2e7b14697f91bf2

data/.rubocop.yml

@@ -37,8 +37,8 @@ Metrics/MethodLength:
 
 Naming/AccessorMethodName:
   Exclude:
-    - 'lib/starter/builder/templates/files.rb'
-    - 'lib/starter/builder/templates/endpoints.rb'
+    - 'lib/starter/templates/files.rb'
+    - 'lib/starter/templates/endpoints.rb'
 
 Style/AsciiComments:
   Enabled: false

data/bin/grape-starter

@@ -38,7 +38,7 @@ command :new do |c|
       starter_gem = Gem::Specification.find_by_name('grape-starter').gem_dir
       src = File.join(starter_gem, 'template', '.')
 
-      Starter::Builder.new!(args.first, src, dest, options)
+      Starter::Build.new!(args.first, src, dest, options)
       $stdout.puts "created: #{args.first}"
 
       # after creating tasks
@@ -71,7 +71,7 @@ command :add do |c|
 
     begin
       builder_options = global_options.merge(set: set).merge(options)
-      created_files = Starter::Builder.add!(resource, builder_options)
+      created_files = Starter::Build.add!(resource, builder_options)
 
       `bundle exec rubocop -a #{created_files.join(' ')}`
       $stdout.puts "added resource: #{resource}"
@@ -87,11 +87,11 @@ command :rm do |c|
   c.desc 'removes also entity file'
   c.switch [:e, :entity], negatable: false
 
-  c.action do |global_options, options, args|
+  c.action do |_global_options, options, args|
     exit_now! 'no resource given' if args.empty?
     resource = args.first
 
-    Starter::Builder.remove!(resource, options)
+    Starter::Build.remove!(resource, options)
 
     $stdout.puts "removed resource: #{resource}"
   end

data/grape-starter.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '>= 6', '< 8'
   spec.add_dependency 'rubocop', '~> 1.24'
   spec.add_dependency 'awesome_print', '~> 1.9'
+  spec.add_dependency 'zeitwerk'
 end

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

@@ -1,16 +1,9 @@
 # frozen_string_literal: true
 
 module Starter
-  require 'starter/builder/orms'
-  require 'starter/builder/names'
-  require 'starter/builder/base_file'
-  require 'starter/builder/file_foo'
-  require 'starter/builder/templates/files'
-  require 'starter/builder/templates/endpoints'
-
-  class Builder
-    extend Names
-    extend BaseFile
+  class Build
+    extend Builder::Names
+    extend Builder::BaseFile
     extend Templates::Files
     extend Templates::Endpoints
 
@@ -120,7 +113,7 @@ module Starter
       # creates a new file in lib folder as namespace, includind the version
       def add_namespace_with_version
         new_lib = File.join(destination, 'lib', base_file_name)
-        FileFoo.write_file(new_lib, base_namespace_file.strip_heredoc)
+        FileOps.write_file(new_lib, base_namespace_file.strip_heredoc)
       end
 
       #
@@ -128,7 +121,7 @@ module Starter
       def replace_static(file, replacement)
         file_path = File.join(destination, file)
 
-        FileFoo.call!(file_path) { |content| content.gsub!('{{{grape-starter}}}', replacement.to_s) }
+        FileOps.call!(file_path) { |content| content.gsub!('{{{grape-starter}}}', replacement.to_s) }
       end
 
       # #add! a new resource releated helper methods
@@ -159,7 +152,7 @@ module Starter
       def save_file(new_file)
         new_file_name = send("#{new_file}_name")
         should_raise?(new_file_name)
-        FileFoo.write_file(new_file_name, send(new_file.strip_heredoc))
+        FileOps.write_file(new_file_name, send(new_file.strip_heredoc))
       end
 
       #

data/lib/starter/builder/{templates/activerecord.rb → activerecord.rb}

@@ -3,7 +3,7 @@
 require 'active_record'
 
 module Starter
-  module Templates
+  module Builder
     module ActiveRecord
       def model_klass
         'ActiveRecord::Base'
@@ -24,13 +24,13 @@ module Starter
 
         ActiveRecord::Base.establish_connection db_conf[env]
         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
+                  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
 
         ActiveRecord::Base.logger = logger
 

data/lib/starter/builder/base_file.rb

@@ -1,45 +1,47 @@
 # frozen_string_literal: true
 
 module Starter
-  module BaseFile
-    # add it in api base
-    def add_mount_point
-      FileFoo.call!(api_base_file_name) { |content| add_to_base(content) }
-    end
-
-    # adding mount point to base class
-    def add_to_base(file)
-      occurence = file.scan(/(\s+mount\s.*?\n)/).last.first
-      replacement = occurence + mount_point
-      file.sub!(occurence, replacement)
-    end
-
-    # removes in api base
-    def remove_mount_point
-      FileFoo.call!(api_base_file_name) { |content| remove_from_base(content) }
-    end
-
-    # removes mount point from base class
-    def remove_from_base(file)
-      file.sub!(mount_point, '')
-    end
-
-    # parses out the prefix from base api file
-    def base_prefix
-      Starter::Config.read[:prefix]
-    end
-
-    # parses out the version from base api file
-    def base_version
-      base_file
-
-      base_file.scan(/version\s+(.+),/).first.first.delete!("'")
-    end
-
-    # get api base file as string
-    def base_file
-      file = File.join(Dir.getwd, 'api', 'base.rb')
-      FileFoo.read_file(file)
+  module Builder
+    module BaseFile
+      # add it in api base
+      def add_mount_point
+        FileOps.call!(api_base_file_name) { |content| add_to_base(content) }
+      end
+
+      # adding mount point to base class
+      def add_to_base(file)
+        occurence = file.scan(/(\s+mount\s.*?\n)/).last.first
+        replacement = occurence + mount_point
+        file.sub!(occurence, replacement)
+      end
+
+      # removes in api base
+      def remove_mount_point
+        FileOps.call!(api_base_file_name) { |content| remove_from_base(content) }
+      end
+
+      # removes mount point from base class
+      def remove_from_base(file)
+        file.sub!(mount_point, '')
+      end
+
+      # parses out the prefix from base api file
+      def base_prefix
+        Starter::Config.read[:prefix]
+      end
+
+      # parses out the version from base api file
+      def base_version
+        base_file
+
+        base_file.scan(/version\s+(.+),/).first.first.delete!("'")
+      end
+
+      # get api base file as string
+      def base_file
+        file = File.join(Dir.getwd, 'api', 'base.rb')
+        FileOps.read_file(file)
+      end
     end
   end
 end

data/lib/starter/builder/names.rb

@@ -1,80 +1,80 @@
 # frozen_string_literal: true
 
 module Starter
-  module Names
-    def klass_name
-      for_klass = prepare_klass
-      singular? ? for_klass.classify : for_klass.classify.pluralize
-    end
+  module Builder
+    module Names
+      def klass_name
+        for_klass = prepare_klass
+        singular? ? for_klass.classify : for_klass.classify.pluralize
+      end
 
-    def lib_klass_name
-      return klass_name unless @orm
+      def lib_klass_name
+        return klass_name unless @orm
 
-      case ::Starter::Config.read[:orm]
-      when 'sequel'
-        require 'starter/builder/templates/sequel'
-        extend(::Starter::Templates::Sequel)
-        "#{klass_name} < #{model_klass}"
-      when 'activerecord', 'ar'
-        require 'starter/builder/templates/activerecord'
-        extend(::Starter::Templates::ActiveRecord)
-        "#{klass_name} < #{model_klass}"
-      else
-        klass_name
+        case Starter::Config.read[:orm]
+        when 'sequel'
+          extend(Starter::Builder::Sequel)
+          "#{klass_name} < #{model_klass}"
+        when 'activerecord', 'ar'
+          extend(Starter::Builder::ActiveRecord)
+          "#{klass_name} < #{model_klass}"
+        else
+          klass_name
+        end
       end
-    end
 
-    # rubocop:disable Style/StringConcatenation
-    def base_file_name
-      @resource.tr('/', '-').downcase + '.rb'
-    end
-    # rubocop:enable Style/StringConcatenation
+      # rubocop:disable Style/StringConcatenation
+      def base_file_name
+        @resource.tr('/', '-').downcase + '.rb'
+      end
+      # rubocop:enable Style/StringConcatenation
 
-    def base_spec_name
-      base_file_name.gsub(/.rb$/, '_spec.rb')
-    end
+      def base_spec_name
+        base_file_name.gsub(/.rb$/, '_spec.rb')
+      end
 
-    def mount_point
-      "    mount Endpoints::#{klass_name}\n"
-    end
+      def mount_point
+        "    mount Endpoints::#{klass_name}\n"
+      end
 
-    def api_base_file_name
-      File.join(Dir.getwd, 'api', 'base.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 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
+      # 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', 'models', base_file_name)
-    end
+      # lib file
+      def lib_file_name
+        File.join(Dir.getwd, 'lib', 'models', base_file_name)
+      end
 
-    # resource spec
-    def api_spec_name
-      File.join(Dir.getwd, 'spec', 'requests', base_spec_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', 'models', base_spec_name)
-    end
+      # lib spec
+      def lib_spec_name
+        File.join(Dir.getwd, 'spec', 'lib', 'models', base_spec_name)
+      end
 
-    private
+      private
 
-    def prepare_klass
-      @resource.tr('-', '/')
-    end
+      def prepare_klass
+        @resource.tr('-', '/')
+      end
 
-    def singular?
-      @resource.singularize.inspect == @resource.inspect
+      def singular?
+        @resource.singularize.inspect == @resource.inspect
+      end
     end
   end
 end

data/lib/starter/builder/{templates/sequel.rb → sequel.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Starter
-  module Templates
+  module Builder
     module Sequel
       def model_klass
         'Sequel::Model'
@@ -20,13 +20,13 @@ module Starter
         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
+                  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
 

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])
@@ -69,11 +69,9 @@ module Starter
 
         case @orm
         when 'sequel'
-          require 'starter/builder/templates/sequel'
-          extend(::Starter::Templates::Sequel)
+          extend(Starter::Builder::Sequel)
         when 'activerecord', 'ar'
-          require 'starter/builder/templates/activerecord'
-          extend(::Starter::Templates::ActiveRecord)
+          extend(Starter::Builder::ActiveRecord)
         else
           @orm = nil
         end
@@ -87,26 +85,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.2'
+  VERSION = '1.6.1'
 end

data/lib/starter.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
 require 'awesome_print'
-
 require 'active_support'
 require 'active_support/core_ext/string'
+require 'zeitwerk'
 
-require 'starter/version'
-require 'starter/builder'
-require 'starter/config'
+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/config/puma.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+workers ENV.fetch('WEB_CONCURRENCY', 0)
+min_threads_count = ENV.fetch('MIN_THREADS', 1)
+max_threads_count = ENV.fetch('MAX_THREADS', 8)
+threads min_threads_count, max_threads_count
+
+port ENV.fetch('PORT', 9292)
+
+environment ENV.fetch('RACK_ENV', 'development')

data/template/script/server

@@ -7,16 +7,4 @@ cd "$(dirname "$0")/.."
 test -z "$RACK_ENV" &&
   RACK_ENV='development'
 
-if [ $1 ]; then
-  PORT=$1
-else
-  PORT=9292
-fi
-
-export PORT=$PORT
-
-if [ "$RACK_ENV" = 'production' ]; then
-  bundle exec thin start -p $PORT -e $RACK_ENV --tag {{{grape-starter}}} -d --threaded
-else
-  bundle exec thin start -p $PORT -e $RACK_ENV --tag {{{grape-starter}}} -D
-fi
+bundle exec puma --tag API-Baz

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-starter
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.1
 platform: ruby
 authors:
 - LeFnord
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-11 00:00:00.000000000 Z
+date: 2023-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -72,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: CLI to create a API skeleton based on Grape and Rack
 email:
 - pscholz.le@gmail.com
@@ -96,18 +110,18 @@ files:
 - doc/re-doc.png
 - grape-starter.gemspec
 - lib/starter.rb
-- lib/starter/builder.rb
+- lib/starter/build.rb
+- lib/starter/builder/activerecord.rb
 - lib/starter/builder/base_file.rb
-- lib/starter/builder/file_foo.rb
 - lib/starter/builder/names.rb
-- lib/starter/builder/orms.rb
-- lib/starter/builder/templates/activerecord.rb
-- lib/starter/builder/templates/endpoints.rb
-- lib/starter/builder/templates/files.rb
-- lib/starter/builder/templates/sequel.rb
+- lib/starter/builder/sequel.rb
 - lib/starter/config.rb
+- lib/starter/file_ops.rb
+- lib/starter/orms.rb
 - lib/starter/rake/grape_tasks.rb
 - lib/starter/rspec/request_specs.rb
+- lib/starter/templates/endpoints.rb
+- lib/starter/templates/files.rb
 - lib/starter/version.rb
 - template/.gitignore
 - template/.rubocop.yml
@@ -125,13 +139,13 @@ files:
 - template/config/boot.rb
 - template/config/environment.rb
 - template/config/initializers/.keep
+- template/config/puma.rb
 - template/lib/models.rb
 - template/lib/models/version.rb
 - template/public/.keep
 - template/script/console
 - template/script/server
 - template/script/setup
-- template/script/stop
 - template/script/test
 - template/script/update
 - template/spec/lib/models/.keep
@@ -157,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: Creates a Grape Rack skeleton

data/template/script/stop

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-
-set -e
-
-cd "$(dirname "$0")/.."
-
-# use only, if server was started in production mode
-thin stop