schienenzeppelin 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7adad707ab6089892e02096e9cb15114ef2bb10b3c3d44d57d2a1eee7e9e1575
-  data.tar.gz: 8363a2a2e485cf173e29586de11f23dfdfaace4817bf442495f9d2b8a0f5cc64
+  metadata.gz: ee71ebdb69f1db2ac35da5916949e0a712630861a068fc1b737a8d0e0d4cd045
+  data.tar.gz: 2cf011f2ed4d0ba7e9b172bf33fbcda4b2217b46058e4cb5ef8867f1a9a94ad5
 SHA512:
-  metadata.gz: 17e4aedfd3e0b09c61cda41bd06fa8983f5e1f9ed675ad64351953a40de40024f99ad9aabf851c3af065f403b763a57937ee1a08fbc10b5dc2086a10a34b5ff2
-  data.tar.gz: b599d828c04e3a0121350c9c6356eddc3b209e011501fcde4ea17da3a8cdc1d583323addaf3d10d8c526caa8f892eff583bc0f868cb39803aa346b3c0eb35680
+  metadata.gz: d50a1100d4d4467fc4e7ef03151a7fb2346d010b65782e209abaf6c3d5c3a40de8141ffe0c7d55fd2d2a31c8cecc8a408b6fab4b2ed2345bc2193d55c6e6213c
+  data.tar.gz: 3f497b097a977ebdc12caa3c2ac5b68f9fc7b6674c081a897099eaa4774b398da372dd9901d1dcf741a0a7010484421db0165dc48c7b800a11ca6c7d860309d5

data/.gitignore

@@ -280,3 +280,5 @@ tags
 
 .bridgetown-cache/
 .bridgetown-webpack/
+
+.rspec_status

data/.rubocop.yml

@@ -5,9 +5,13 @@ AllCops:
 Naming/AccessorMethodName:
   Enabled: false
 
+Metrics/ClassLength:
+  Max: 300
+
 Metrics/MethodLength:
   CountAsOne: ['array', 'heredoc']
   IgnoredMethods: ['describe', 'context']
+  Max: 20
 
 Metrics/BlockLength:
   IgnoredMethods: ['describe', 'context']
@@ -17,7 +21,7 @@ Layout/LineLength:
   Max: 120
 
 Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
+  EnforcedStyle: indented_relative_to_receiver
 
 Style/BlockDelimiters:
   Exclude:

data/.tool-versions

@@ -1 +1 @@
-ruby 2.6.6
+ruby 3.0.0

data/CHANGELOG.md

@@ -0,0 +1 @@
+

data/Gemfile

@@ -11,3 +11,4 @@ gem 'rspec', '~> 3.10'
 
 gem 'rubocop', '~> 1.9'
 gem 'rubocop-rspec', '~> 1.40'
+gem 'super_diff'

data/Gemfile.lock

@@ -1,72 +1,73 @@
 PATH
   remote: .
   specs:
-    schienenzeppelin (0.1)
-      rails (~> 6.1.2)
+    schienenzeppelin (0.2)
+      rails (~> 6.1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.1.2.1)
-      actionpack (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
+    actioncable (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.1.2.1)
-      actionpack (= 6.1.2.1)
-      activejob (= 6.1.2.1)
-      activerecord (= 6.1.2.1)
-      activestorage (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
+    actionmailbox (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
       mail (>= 2.7.1)
-    actionmailer (6.1.2.1)
-      actionpack (= 6.1.2.1)
-      actionview (= 6.1.2.1)
-      activejob (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
+    actionmailer (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.1.2.1)
-      actionview (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
+    actionpack (6.1.3.1)
+      actionview (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.1.2.1)
-      actionpack (= 6.1.2.1)
-      activerecord (= 6.1.2.1)
-      activestorage (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
+    actiontext (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
       nokogiri (>= 1.8.5)
-    actionview (6.1.2.1)
-      activesupport (= 6.1.2.1)
+    actionview (6.1.3.1)
+      activesupport (= 6.1.3.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.1.2.1)
-      activesupport (= 6.1.2.1)
+    activejob (6.1.3.1)
+      activesupport (= 6.1.3.1)
       globalid (>= 0.3.6)
-    activemodel (6.1.2.1)
-      activesupport (= 6.1.2.1)
-    activerecord (6.1.2.1)
-      activemodel (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
-    activestorage (6.1.2.1)
-      actionpack (= 6.1.2.1)
-      activejob (= 6.1.2.1)
-      activerecord (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
-      marcel (~> 0.3.1)
-      mimemagic (~> 0.3.2)
-    activesupport (6.1.2.1)
+    activemodel (6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activerecord (6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activestorage (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      marcel (~> 1.0.0)
+      mini_mime (~> 1.0.2)
+    activesupport (6.1.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
     ast (2.4.2)
+    attr_extras (6.2.4)
     builder (3.2.4)
     concurrent-ruby (1.1.8)
     crass (1.0.6)
@@ -74,58 +75,59 @@ GEM
     erubi (1.10.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.8.9)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    loofah (2.9.0)
+    loofah (2.9.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
+    marcel (1.0.1)
     method_source (1.0.0)
-    mimemagic (0.3.5)
-    mini_mime (1.0.2)
-    minitest (5.14.3)
-    nio4r (2.5.5)
-    nokogiri (1.11.1-x86_64-linux)
+    mini_mime (1.0.3)
+    minitest (5.14.4)
+    nio4r (2.5.7)
+    nokogiri (1.11.3-x86_64-linux)
       racc (~> 1.4)
+    optimist (3.0.1)
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
+    patience_diff (1.2.0)
+      optimist (~> 3.0)
     racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.1.2.1)
-      actioncable (= 6.1.2.1)
-      actionmailbox (= 6.1.2.1)
-      actionmailer (= 6.1.2.1)
-      actionpack (= 6.1.2.1)
-      actiontext (= 6.1.2.1)
-      actionview (= 6.1.2.1)
-      activejob (= 6.1.2.1)
-      activemodel (= 6.1.2.1)
-      activerecord (= 6.1.2.1)
-      activestorage (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
+    rails (6.1.3.1)
+      actioncable (= 6.1.3.1)
+      actionmailbox (= 6.1.3.1)
+      actionmailer (= 6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actiontext (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
       bundler (>= 1.15.0)
-      railties (= 6.1.2.1)
+      railties (= 6.1.3.1)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.1.2.1)
-      actionpack (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
+    railties (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
       method_source
       rake (>= 0.8.7)
       thor (~> 1.0)
     rainbow (3.0.0)
     rake (13.0.3)
-    regexp_parser (2.0.3)
+    regexp_parser (2.1.1)
     rexml (3.2.4)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -136,11 +138,11 @@ GEM
     rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.1)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.1)
-    rubocop (1.9.1)
+    rspec-support (3.10.2)
+    rubocop (1.11.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -161,6 +163,10 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
+    super_diff (0.6.1)
+      attr_extras (>= 6.2.4)
+      diff-lcs
+      patience_diff
     thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
@@ -179,6 +185,7 @@ DEPENDENCIES
   rubocop (~> 1.9)
   rubocop-rspec (~> 1.40)
   schienenzeppelin!
+  super_diff
 
 BUNDLED WITH
-   2.2.7
+   2.2.14

data/TODO.md

@@ -1,32 +1,44 @@
-
 # TODO
 
-## Phase 2
-- Schienenzeppelin Repo CI (notify gem releases, tests)
-- Loads of testing
-- Hide generators and scaffolds in sz gem, don't copy as templates. See JB, use railtie
+## Next up
 
-## Phase 3
-- Make everything skippable, manage dependencies between items
+- Dependency management for options e.g.
+  - Testing framework
+  - Deployment framework
+  - Background processing
 - Take advantage of saved config (as rails new does)
-- Licensing? 
-- Homepage & Newsletter
-- Goodies for Business: 
-    - Admin pages
-    - Social Logins
-    - Cloud Storage ?
-    - Payments
-    - Monitoring (Skylight, ...)
-    - Email Providers (Mailgun, ...)
-    - Reporting (Bugsnag, ...)
-    - Dockerfile
-    - https://dev.to/citronak/modern-rails-flash-messages-part-1-viewcomponent-stimulus-tailwind-css-3alm
-- Configuration wizard via command line
-- Alternative configurations:
-    - Differernt DB
-    - Different BG Jobs
-    - Different Deployment
-  
 - Additional Gems:
   - Pagy
+
+- More dependency stuff:
+  - Adapt test command in CI
+  - Adapt capfile for skips (sidekiq)
+  - Adapt docker-compose for skips (database, webpack...)
+  - Adapt dockerfile & entrypoint for skips (database, webpack...)
+  - Adapt dotenv for skips (database)
+  - Adapt setup for skips (database, sidekiq...)
+  
+## Future
+
+- Proper Icon
+- Homepage & Newsletter & Docs
+  
+## Far Future
+
+- Licensing?
+- Goodies for Business:
+  - Admin pages
+  - Social Logins
+  - Cloud Storage ?
+  - Payments
+  - Monitoring (Skylight, ...)
+  - Email Providers (Mailgun, ...)
+  - Reporting (Bugsnag, ...)
+  - Dockerfile
+  - https://dev.to/citronak/modern-rails-flash-messages-part-1-viewcomponent-stimulus-tailwind-css-3alm
+- Configuration wizard via command line
+- Alternative configurations:
+  - Differernt DB
+  - Different BG Jobs
+  - Different Deployment
 - Ansible repo setup if deploy is Capistrano

data/lib/schienenzeppelin.rb

@@ -8,8 +8,11 @@ require 'rails/generators/rails/app/app_generator'
 require 'bundler'
 
 require_relative 'schienenzeppelin/version'
-require_relative 'schienenzeppelin/helper_base'
-Dir[File.join(__dir__, 'schienenzeppelin', 'helpers', '*.rb')].sort.each { |file| require file }
+require_relative 'schienenzeppelin/context'
+require_relative 'schienenzeppelin/dependencies'
+require_relative 'schienenzeppelin/add_on'
+Dir[File.join(__dir__, 'schienenzeppelin', 'addons', '*.rb')].each { |file| require file }
+require_relative 'schienenzeppelin/generator_utils'
 require_relative 'schienenzeppelin/app_generator'
 require_relative 'schienenzeppelin/app_builder'
 

data/lib/schienenzeppelin/add_on.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  class AddOn < Rails::Generators::Base
+    include Thor::Actions
+    include Rails::Generators::Actions
+    include Rails::Generators::AppName
+
+    attr_reader :dependencies, :context
+
+    def initialize(context)
+      super
+      @context = context
+      @dependencies = self.class.dependencies || []
+    end
+
+    def apply; end
+
+    no_commands do
+      def options
+        @context.options
+      end
+
+      def uses?(identifier = nil)
+        identifier ||= self.class.identifier
+        options = @context.options
+        return false if options["skip_#{identifier}".to_sym]
+
+        return true if @context.default_addons.include?(identifier)
+
+        clazz = identifier.nil? ? self.class : self.class.get(identifier)
+        Dependencies.new(clazz, @context).satisfied?
+      end
+    end
+
+    class << self
+      def default_source_root
+        File.expand_path(File.join('..', '..', 'templates'), __dir__)
+      end
+
+      def apply(context = Context.new({}))
+        instance = new(context)
+        return unless instance.uses?
+
+        instance.apply
+      end
+
+      def get(addon)
+        addon = addon.to_s.capitalize.camelize
+        "Schienenzeppelin::AddOns::#{addon}".constantize
+      end
+
+      def identifier
+        name.demodulize.underscore.to_sym
+      end
+
+      def dependencies
+        @dependencies ||= []
+      end
+
+      protected
+
+      def depends_on(*addon)
+        @dependencies = addon.map(&:to_sym)
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/{helpers → addons}/annotate.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 module Schienenzeppelin
-  module Helpers
-    class Annotate < HelperBase
+  module AddOns
+    class Annotate < AddOn
+      depends_on :active_record
+
       def apply
         template('lib/tasks/auto_annotate_models.rake', force: true)
       end