rails_app_generator 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d89c170613dfb0e417f3ffd838fe43054131e448217472168598dcafff90b127
-  data.tar.gz: eb356aed6b4f8abb01599f0b4e1433c38b147b47b88548b9543a13d1dbf65ee7
+  metadata.gz: a977e13e740b6061b3d3ad51ceb945bb1397d575f10079bdaa990d40736a9238
+  data.tar.gz: aec7a7184348cbe4b67b1af22cb8ac4147e647a1b01ade79a0d21fd34fc114ae
 SHA512:
-  metadata.gz: efaf6e2c86116e185492707cc553f33d2dfe6a10739f9f7db4132f62f064a3d923da48c5b016a754e12d44a330e73b8461930fc33737e5d12ae1b1ba6100737b
-  data.tar.gz: 1ba8f9198b73bedfbb6b0835c72f690a15dfa0e1fb6c5a83e576c2a17fbe8f7e6f1fdec7ae04cbad983a195c44ef66f2bc5cd338df9fe3ee5dbfbc96c4b95482
+  metadata.gz: de59016f6f5a06e138a3380733a961bfb000e0f838456dc9b8c813747c939d9087ed31d8d295d258c3658e883e188a5fdafa7bfe4e04e8d8eb2907a26cdbc94e
+  data.tar.gz: a11097251170838db6e12f32397e2e7df1a8d713cc27b6be96eaa7cda8afc6095b1bd146a73df33933a63fbb7280c06c70b95783b906d2ffab53fade10c131da

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [0.0.2](https://github.com/klueless-io/rails_app_generator/compare/v0.0.1...v0.0.2) (2022-07-19)
+
+
+### Bug Fixes
+
+* claim Ruby Gem name ([e15c681](https://github.com/klueless-io/rails_app_generator/commit/e15c6819eda783a345b79db3e22e544b50d9ef7c))
+
 ## [Unreleased]
 
 ## [0.1.0] - 2022-07-16

data/lib/rails_app_generator/notes/register-options.txt

@@ -0,0 +1,25 @@
+register_option :template,            type: :string                             , desc: "Path to some #{name} template (can be a filesystem path or URL)"
+register_option :database,            type: :string , default: "sqlite3"        , desc: "Preconfigure for selected database (options: #{DATABASES.join('/')})"
+register_option :skip_git,            type: :boolean, default: false            , desc: "Skip .gitignore file"
+register_option :skip_keeps,          type: :boolean, default: false            , desc: "Skip source control .keep files"
+register_option :skip_action_mailer,  type: :boolean, default: false            , desc: "Skip Action Mailer files"
+register_option :skip_action_mailbox, type: :boolean, default: false            , desc: "Skip Action Mailbox gem"
+register_option :skip_action_text,    type: :boolean, default: false            , desc: "Skip Action Text gem"
+register_option :skip_active_record,  type: :boolean, default: false            , desc: "Skip Active Record files"
+register_option :skip_active_job,     type: :boolean, default: false            , desc: "Skip Active Job"
+register_option :skip_active_storage, type: :boolean, default: false            , desc: "Skip Active Storage files"
+register_option :skip_action_cable,   type: :boolean, default: false            , desc: "Skip Action Cable files"
+register_option :skip_asset_pipeline, type: :boolean, default: false
+register_option :asset_pipeline,      type: :string , default: "sprockets"      , desc: "Choose your asset pipeline [options: sprockets (default), propshaft]"
+register_option :skip_javascript,     type: :boolean, default: name == "plugin" , desc: "Skip JavaScript files"
+register_option :skip_hotwire,        type: :boolean, default: false            , desc: "Skip Hotwire integration"
+register_option :skip_jbuilder,       type: :boolean, default: false            , desc: "Skip jbuilder gem"
+register_option :skip_test,           type: :boolean, default: false            , desc: "Skip test files"
+register_option :skip_system_test,    type: :boolean, default: false            , desc: "Skip system test files"
+register_option :skip_bootsnap,       type: :boolean, default: false            , desc: "Skip bootsnap gem"
+register_option :dev,                 type: :boolean, default: false            , desc: "Set up the #{name} with Gemfile pointing to your Rails checkout"
+register_option :edge,                type: :boolean, default: false            , desc: "Set up the #{name} with Gemfile pointing to Rails repository"
+register_option :main,                type: :boolean, default: false            , desc: "Set up the #{name} with Gemfile pointing to Rails repository main branch"
+register_option :rc,                  type: :string , default: nil              , desc: "Path to file containing extra configuration options for rails command"
+register_option :no_rc,               type: :boolean, default: false            , desc: "Skip loading of extra configuration options from .railsrc file"
+register_option :help,                type: :boolean, group: :rails             , desc: "Show this help message and quit"

data/lib/rails_app_generator/options/build_option.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Option for the rails generator
+  #
+  # This class maps closely (but not exactly) to Thor's options
+  # The pattern is not exactly the same, it is easy to map the options
+  # you need from other generators such as: railties/lib/rails/generators/app_base.rb
+  #
+  # @example
+  # class_option    :skip_git, type: :boolean, default: false, desc: "Skip .gitignore file"
+  # becomes
+  # register_option :skip_git, type: :boolean, default: false, desc: "Skip .gitignore file"
+  class BuildOption
+    attr_reader :name, :desc, :type, :default, :required, :mapper
+
+    def initialize(**args)
+      @name = args[:name]
+      @desc = args[:desc] || ''
+      @type = args[:type] || :string
+      @required = args.fetch(:required, false)
+      @default = args[:default] || sane_default
+      @mapper = args[:mapper] || sane_mapper
+
+      raise ArgumentError, ':required should not be nil' if @required.nil?
+    end
+
+    def cmd_option(value); end
+
+    private
+
+    def sane_default
+      case type
+      when :string
+        ''
+      when :boolean
+        false
+      when :integer
+        0
+      when :array
+        []
+      when :hash
+        {}
+      end
+    end
+
+    def sane_mapper
+      case type
+      when :boolean
+        RailsAppGenerator::MapOptionBooleanFlag
+      else
+        RailsAppGenerator::MapOptionValue
+      end
+    end
+  end
+end

data/lib/rails_app_generator/{build_options.rb → options/build_options.rb}

@@ -16,19 +16,31 @@ module RailsAppGenerator
         @registered_options ||= []
       end
 
-      def register(name, **args)
-        registered_options << BuildOption.new(**{ name: name }.merge(args))
+      def registered_options_lookup
+        @registered_options_lookup ||= {}
+      end
+
+      def register_option(name, **args)
+        return if registered_options_lookup.key?(name)
+
+        option = BuildOption.new(**{ name: name }.merge(args))
+
+        registered_options_lookup[name] = option
+        registered_options << option
       end
 
       def reset
         @registered_options = nil
+        @registered_options_lookup = nil
       end
     end
 
-    def rails_options
-      build_options
-
-      []
+    def cmd_line_options
+      self.class.registered_options.map do |option|
+        mapper = option.mapper
+        value = options[option.name]
+        mapper.map(option.name, value)
+      end.reject(&:blank?)
     end
 
     private

data/lib/rails_app_generator/options/map_option_boolean_flag.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Map a boolean true to a command line flag in the format "--flag-name"
+  # false is ignored
+  class MapOptionBooleanFlag
+    def self.map(name, value)
+      value == true ? "--#{name.to_s.gsub('_', '-')}" : ''
+    end
+  end
+end

data/lib/rails_app_generator/options/map_option_pass_through.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Simple pass through mapper for options that do not yet have a mapper defined
+  class MapOptionValue
+    def self.map(_name, value)
+      value
+    end
+  end
+end

data/lib/rails_app_generator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsAppGenerator
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/rails_app_generator.rb

@@ -10,8 +10,10 @@ require 'rails/generators/rails/app/app_generator'
 require 'bundler'
 
 require 'rails_app_generator/version'
-require 'rails_app_generator/build_option'
-require 'rails_app_generator/build_options'
+require 'rails_app_generator/options/map_option_pass_through'
+require 'rails_app_generator/options/map_option_boolean_flag'
+require 'rails_app_generator/options/build_option'
+require 'rails_app_generator/options/build_options'
 require 'rails_app_generator/starter'
 require 'rails_app_generator/app_builder'
 require 'rails_app_generator/app_generator'

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "rails_app_generator",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "rails_app_generator",
-      "version": "0.0.2",
+      "version": "0.0.3",
       "devDependencies": {
         "@klueless-js/semantic-release-rubygem": "github:klueless-js/semantic-release-rubygem",
         "@semantic-release/changelog": "^6.0.1",

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rails_app_generator",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Create new Rails Application with custom opinions",
   "scripts": {
     "release": "semantic-release"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_app_generator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - David Cruwys
@@ -49,8 +49,6 @@ files:
 - lib/rails_app_generator.rb
 - lib/rails_app_generator/app_builder.rb
 - lib/rails_app_generator/app_generator.rb
-- lib/rails_app_generator/build_option.rb
-- lib/rails_app_generator/build_options.rb
 - lib/rails_app_generator/generators/advisories_generator.rb
 - lib/rails_app_generator/generators/base.rb
 - lib/rails_app_generator/generators/foo_generator.rb
@@ -58,8 +56,13 @@ files:
 - lib/rails_app_generator/notes/methods-class.txt
 - lib/rails_app_generator/notes/methods-instance.txt
 - lib/rails_app_generator/notes/option-rules.txt
+- lib/rails_app_generator/notes/register-options.txt
 - lib/rails_app_generator/notes/usage-gem.txt
 - lib/rails_app_generator/notes/usage-rails.txt
+- lib/rails_app_generator/options/build_option.rb
+- lib/rails_app_generator/options/build_options.rb
+- lib/rails_app_generator/options/map_option_boolean_flag.rb
+- lib/rails_app_generator/options/map_option_pass_through.rb
 - lib/rails_app_generator/starter.rb
 - lib/rails_app_generator/version.rb
 - package-lock.json

data/lib/rails_app_generator/build_option.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module RailsAppGenerator
-  # Option for the rails generator
-  class BuildOption
-    attr_reader :name, :description, :type, :default, :required
-
-    def initialize(**args)
-      @name = args[:name]
-      @description = args[:description] || ''
-      @type = args[:type] || :string
-      @required = args.fetch(:required, false)
-      @default = args[:default] || sane_default
-
-      raise ArgumentError, ':required should not be nil' if @required.nil?
-    end
-
-    private
-
-    def sane_default
-      case type
-      when :string
-        ''
-      when :boolean
-        false
-      when :integer
-        0
-      when :array
-        []
-      when :hash
-        {}
-      end
-    end
-  end
-end