grape-starter 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bf6bb14f7920a1c45c3bbd5737167d239f752b31d2977416647ac96f9ef7207
-  data.tar.gz: 6d9a2bb32927b585a1f32bae838f79edadb634420492f5c5b149c50754dc4c33
+  metadata.gz: 70eb1ef044b58a9637cb920fcc9129a12ca25392d5d160de75a6ee3ea9483052
+  data.tar.gz: c700ad85e12e2406b11a647d8584d3070d7e6e9c10742fba0909a8182264dff5
 SHA512:
-  metadata.gz: 439b3e8c90b6e79c3b61da51b27ff4158e5958271035da0aa8181a0c8664cda39f4140fd32708cc013893932b5e795c42d3e9a8101776594fde0258c0986c610
-  data.tar.gz: ec9da624c7c41f6c0af7660650ea53da8b3da609e7354e878e07dbfd80e1dca0aa4a3092a6243ef5786547d1d3f4e10efb49fc9e5e256dc8dbe968a902102436
+  metadata.gz: c46ea6564c067d4174c29d705482068b991589503928bb5de57f0cfb5b0034485d48a8f3dc7f4b52621110727d6b78f7d86544682ea2d9ebf36054ba00029da8
+  data.tar.gz: ba9e7eb94b6e5412baba003037927310686dae982b439fffb5241d800101c405999c4246ad22c44b175ba3d676c52af632c8f24eb6241cfacab42995e36297d0

data/.github/workflows/pipeline.yml

@@ -12,10 +12,10 @@ jobs:
   rubocop:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.1'
+          ruby-version: '3.2'
           bundler-cache: true
       - name: Run rubocop
         run: bundle exec rubocop --parallel --format progress
@@ -25,10 +25,10 @@ jobs:
     needs: ['rubocop']
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1', head]
+        ruby-version: ['3.0', '3.1', '3.2', head]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/.rubocop.yml

@@ -14,7 +14,7 @@ AllCops:
     - template/spec/spec-helper.rb
   UseCache: true
   NewCops: enable
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.2
   SuggestExtensions: false
 
 Layout/IndentationWidth:
@@ -45,3 +45,6 @@ Style/AsciiComments:
 
 Style/Documentation:
   Enabled: false
+
+Style/HashSyntax:
+  Enabled: false # to support ruby 3.0

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,18 +1,18 @@
 # 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
-    extend Templates::Files
-    extend Templates::Endpoints
+  # 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 Build
+    extend Builder::Names
+    extend Builder::BaseFile
+    extend Builder::Templates::Files
+    extend Builder::Templates::Endpoints
 
     class << self
       attr_reader :prefix, :resource, :set, :force, :entity, :destination, :orm
@@ -120,7 +120,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 +128,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 +159,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/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,82 @@
 # 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'
+          require 'starter/builder/templates/sequel'
+          extend(Starter::Builder::Templates::Sequel)
+          "#{klass_name} < #{model_klass}"
+        when 'activerecord', 'ar'
+          require 'starter/builder/templates/activerecord'
+          extend(Starter::Builder::Templates::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/activerecord.rb

@@ -3,102 +3,104 @@
 require 'active_record'
 
 module Starter
-  module Templates
-    module ActiveRecord
-      def model_klass
-        'ActiveRecord::Base'
-      end
+  module Builder
+    module Templates
+      module ActiveRecord
+        def model_klass
+          'ActiveRecord::Base'
+        end
 
-      def initializer
-        <<-FILE.strip_heredoc
-        # frozen_string_literal: true
-
-        require 'yaml'
-        require 'erb'
-        require 'active_record'
-
-        config_content = File.read(File.join('config', 'database.yml'))
-
-        db_conf = YAML.safe_load(ERB.new(config_content).result)
-        env = ENV['RACK_ENV'] || 'development'
-
-        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
-
-        ActiveRecord::Base.logger = logger
-
-        # Middleware
-        module ActiveRecord
-          module Rack
-            # ActiveRecord >= 5 removes the Pool management
-            class ConnectionManagement
-              def initialize(app)
-                @app = app
-              end
+        def initializer
+          <<-FILE.strip_heredoc
+          # frozen_string_literal: true
+
+          require 'yaml'
+          require 'erb'
+          require 'active_record'
+
+          config_content = File.read(File.join('config', 'database.yml'))
+
+          db_conf = YAML.safe_load(ERB.new(config_content).result)
+          env = ENV['RACK_ENV'] || 'development'
+
+          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
+
+          ActiveRecord::Base.logger = logger
+
+          # Middleware
+          module ActiveRecord
+            module Rack
+              # ActiveRecord >= 5 removes the Pool management
+              class ConnectionManagement
+                def initialize(app)
+                  @app = app
+                end
+
+                def call(env)
+                  response = @app.call(env)
+                  response[2] = ::Rack::BodyProxy.new(response[2]) do
+                    ActiveRecord::Base.clear_active_connections!
+                  end
 
-              def call(env)
-                response = @app.call(env)
-                response[2] = ::Rack::BodyProxy.new(response[2]) do
+                  return response
+                rescue StandardError
                   ActiveRecord::Base.clear_active_connections!
+                  raise
                 end
-
-                return response
-              rescue StandardError
-                ActiveRecord::Base.clear_active_connections!
-                raise
               end
             end
           end
+          FILE
         end
-        FILE
-      end
 
-      def rakefile
-        <<-FILE.strip_heredoc
-        # ActiveRecord migration tasks
-        require 'active_record'
-        include ActiveRecord::Tasks
-        config_dir = File.expand_path('../config', __FILE__)
-        config_content = File.join(config_dir, 'database.yml')
-        DatabaseTasks.env = ENV['RACK_ENV'] || 'development'
-        DatabaseTasks.database_configuration = YAML.load_file(config_content)
-        DatabaseTasks.db_dir = 'db'
-        DatabaseTasks.migrations_paths = File.join('db', 'migrate')
-
-        ActiveRecord::Base.configurations = DatabaseTasks.database_configuration
-        ActiveRecord::Base.establish_connection DatabaseTasks.env.to_sym
-
-        load 'active_record/railties/databases.rake'
-        FILE
-      end
+        def rakefile
+          <<-FILE.strip_heredoc
+          # ActiveRecord migration tasks
+          require 'active_record'
+          include ActiveRecord::Tasks
+          config_dir = File.expand_path('../config', __FILE__)
+          config_content = File.join(config_dir, 'database.yml')
+          DatabaseTasks.env = ENV['RACK_ENV'] || 'development'
+          DatabaseTasks.database_configuration = YAML.load_file(config_content)
+          DatabaseTasks.db_dir = 'db'
+          DatabaseTasks.migrations_paths = File.join('db', 'migrate')
+
+          ActiveRecord::Base.configurations = DatabaseTasks.database_configuration
+          ActiveRecord::Base.establish_connection DatabaseTasks.env.to_sym
+
+          load 'active_record/railties/databases.rake'
+          FILE
+        end
 
-      def gemfile
-        <<-FILE.strip_heredoc
-        # DB stuff
-        gem 'activerecord', '>= 6'
-        gem 'pg'
-        FILE
-      end
+        def gemfile
+          <<-FILE.strip_heredoc
+          # DB stuff
+          gem 'activerecord', '>= 6'
+          gem 'pg'
+          FILE
+        end
 
-      def migration(klass_name, resource)
-        version = "#{::ActiveRecord::VERSION::MAJOR}.#{::ActiveRecord::VERSION::MINOR}"
-        <<-FILE.strip_heredoc
-        class Create#{klass_name} < ActiveRecord::Migration[#{version}]
-          def change
-            create_table :#{resource} do |t|
+        def migration(klass_name, resource)
+          version = "#{::ActiveRecord::VERSION::MAJOR}.#{::ActiveRecord::VERSION::MINOR}"
+          <<-FILE.strip_heredoc
+          class Create#{klass_name} < ActiveRecord::Migration[#{version}]
+            def change
+              create_table :#{resource} do |t|
 
-              t.timestamps
+                t.timestamps
+              end
             end
           end
+          FILE
         end
-        FILE
       end
     end
   end