rails_app_generator 0.0.7 → 0.0.10

data/docs/project-plan.md

@@ -0,0 +1,24 @@
+# Drawio Dsl - Project Plan
+
+## In Progress
+
+The next ticket to work on
+
+![](project-plan/project_in_progress.svg)
+
+## To Do
+
+List of tickets to do
+
+![](project-plan/project_todo.svg)
+
+## Complete
+
+List of completed tickets
+
+![](project-plan/project_done.svg)
+
+
+## Copyright
+
+Copyright (c) David Cruwys. See [MIT License](LICENSE.txt) for further details.

data/exe/rag

@@ -19,23 +19,52 @@ elsif %w[-v --version].include? ARGV[0]
   exit 0
 end
 
-profile_path = File.expand_path("#{Pathname.new(__FILE__).dirname}/../profiles")
-profile_name = ARGV[0]
-profile_name += '.json' unless profile_name.end_with?('.json')
-profile_file = File.join(profile_path, profile_name)
-
-if File.exist?(profile_file)
-  puts "Using profile #{profile_file}"
-
-  profile = JSON.parse(File.read(profile_file), symbolize_names: true)
-  args = profile[:args]
-  opts = profile[:opts]
-  rails_options = RailsAppGenerator::RailsOptions.new(opts)
-
-  instance = RailsAppGenerator::Starter.new(args)
-  FileUtils.rm_rf(instance.target_path)
-  instance.start(rails_options)
-else
-  puts "Profile #{profile_file} not found"
-  exit 1
-end
+RailsAppGenerator::Cli.start(ARGV)
+
+exit 0
+
+# # Use RAG with in the same way as the Rails generator (the following commands should be equivalent)
+# #   rails new args
+# #   rag   new args
+# if ARGV.first == 'new'
+#   # NOTE: This is not yet working
+#   RailsAppGenerator::Cli::Standard.start ARGV[1..]
+#   exit 0
+# elsif ARGV.first == 'diff'
+#   # args, opts = Thor::Arguments.split(ARGV[1..])
+#   RailsAppGenerator::Cli::Diff.start(ARGV[1..]) # , { lhs: true, rhs: true, compare: true } )
+#   exit 0
+# elsif ARGV.first == 'diff_lhs'
+#   RailsAppGenerator::Cli::Diff.start(ARGV[1..], { lhs: true })
+#   exit 0
+# elsif ARGV.first == 'diff_rhs'
+#   RailsAppGenerator::Cli::Diff.start(ARGV[1..], { rhs: true })
+#   exit 0
+# elsif ARGV.first == 'diff_compare'
+#   RailsAppGenerator::Cli::Diff.start(ARGV[1..], { compare: true })
+#   exit 0
+# elsif !ARGV.first.nil?
+#   profile_path = File.expand_path("#{Pathname.new(__FILE__).dirname}/../profiles")
+#   profile_name = ARGV[0]
+#   profile_name += '.json' unless profile_name.end_with?('.json')
+#   profile_file = File.join(profile_path, profile_name)
+
+#   RailsAppGenerator::Cli::Profile.start(profile_file)
+
+#   exit 0
+# end
+
+# if File.exist?(profile_file)
+#   puts "Using profile #{profile_file}"
+
+#   profile = JSON.parse(File.read(profile_file), symbolize_names: true)
+#   args = profile[:args]
+#   opts = profile[:opts]
+#   rails_options = RailsAppGenerator::RailsOptions.new(opts)
+
+#   instance = RailsAppGenerator::Starter.new(args)
+#   FileUtils.rm_rf(instance.target_path)
+#   instance.start(rails_options)
+# else
+# puts "Profile #{profile_file} not found"
+# exit 1

data/lib/rails_app_generator/app_generator.rb

@@ -171,6 +171,14 @@ module RailsAppGenerator
     end
 
     no_commands do
+      # USED BY AFTER_TEMPLATE
+      def gac(message)
+        return unless active?(:git)
+
+        git add: '.'
+        git commit: " -m '#{message}'"
+      end
+
       def add_controller(name, *args)
         generate(:controller, name, *args)
       end
@@ -179,14 +187,28 @@ module RailsAppGenerator
         generate(:scaffold, name, *args)
       end
 
+      def read_template(template_file)
+        path = find_in_source_paths(template_file)
+
+        File.read(path)
+      end
+
+      def join_templates(*template_files, join: "\n\n")
+        template_files.map { |template_file| read_template(template_file) }.join(join)
+      end
+
+      # Local template path is handy when you want template files used when working with the --template flag
+      attr_accessor :local_template_path
+
       def source_paths
-        [
-          context.rails_override_template_path,
-          context.rails_template_path
-        ]
+        paths = local_template_path ? [local_template_path] : []
+        paths << context.rails_override_template_path
+        paths << context.rails_template_path
+        paths
       end
 
       # Context wraps the configured options and can be made available to addons
+      # TODO: should I add local_template_path to the context?
       def context
         @context ||= Context.new(
           self.class.rails_template_path,
@@ -210,8 +232,28 @@ module RailsAppGenerator
         add(addon) if options[option_name]
       end
 
+      def skip_flag?(option_name)
+        value = options["skip_#{option_name}".to_sym]
+
+        return false if value.nil?
+
+        value == true
+      end
+
+      def add_flag?(option_name)
+        value = options["add_#{option_name}".to_sym]
+
+        return false if value.nil?
+
+        value == true
+      end
+
+      def active?(option_name)
+        add_flag?(option_name) || !skip_flag?(option_name)
+      end
+
       def uses?(addon)
-        return false if options["skip_#{addon}".to_sym]
+        return false unless active?(addon)
 
         addon = AddOn.get(addon)
         Dependencies.new(addon, context).satisfied?

data/lib/rails_app_generator/cli.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Thor CLI
+  class Cli < Thor
+    desc 'diff lhs_folder rhs_folder [options]', 'Diff two different rails folders'
+    option :lhs     , type: :boolean
+    option :rhs     , type: :boolean
+    option :compare , type: :boolean
+
+    def diff(lhs_folder, rhs_folder)
+      # puts "Diffing #{lhs_folder} and #{rhs_folder}"
+      # puts JSON.pretty_generate(options)
+      processor = RailsAppGenerator::Diff::Processor.new(lhs_folder, rhs_folder)
+      compare_info = processor.compare
+
+      compare_info.debug
+
+      # report = RailsAppGenerator::Diff::Report.new(compare_info)
+      # report.display
+    end
+
+    # def initialize(profile_file)
+    #   @profile_file = profile_file
+    # end
+
+    # def run
+    #   puts "Using profile #{profile_file}"
+
+    #   profile = JSON.parse(File.read(profile_file), symbolize_names: true)
+    #   args = profile[:args]
+    #   opts = profile[:opts]
+    #   rails_options = RailsAppGenerator::RailsOptions.new(opts)
+
+    #   instance = RailsAppGenerator::Starter.new(args)
+    #   FileUtils.rm_rf(instance.target_path)
+    #   instance.start(rails_options)
+    # end
+  end
+end

data/lib/rails_app_generator/diff/compare_info.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  module Diff
+    # CompareInfo information
+    class CompareInfo
+      attr_reader :lhs_path
+      attr_reader :lhs_files
+      attr_reader :lhs_only
+
+      attr_reader :rhs_path
+      attr_reader :rhs_files
+      attr_reader :rhs_only
+
+      attr_reader :diff_list
+      attr_reader :same_list
+
+      def initialize(lhs_path, lhs_files, rhs_path, rhs_files)
+        @lhs_path   = lhs_path
+        @lhs_files  = lhs_files
+        @lhs_only   = []
+
+        @rhs_path   = rhs_path
+        @rhs_files  = rhs_files
+        @rhs_only   = []
+
+        @diff_list  = []
+        @same_list  = []
+
+        separate_files(lhs_path, lhs_files, rhs_path, rhs_files)
+      end
+
+      def debug
+        debug_stats
+        debug_files('left only', lhs_only)
+        debug_files('right only', rhs_only)
+        debug_files('same', same_list)
+        debug_files('diff', diff_list)
+      end
+
+      private
+
+      def separate_files(lhs_path, lhs_files, rhs_path, rhs_files)
+        @lhs_only = lhs_files - rhs_files
+        @rhs_only = rhs_files - lhs_files
+
+        matching_files = lhs_files & rhs_files
+
+        matching_files.each do |file|
+          if FileUtils.compare_file(File.join(lhs_path, file), File.join(rhs_path, file))
+            @same_list << file
+          else
+            @diff_list << file
+          end
+        end
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def debug_stats
+        Util.kv('left path'               , lhs_path)
+        Util.kv('right path'              , rhs_path)
+
+        Util.kv('file count - left'       , lhs_files.count)
+        Util.kv('file count - right'      , rhs_files.count)
+
+        Util.kv('file count - left only'  , lhs_only.count)
+        Util.kv('file count - right only' , rhs_only.count)
+
+        Util.kv('file count - same'       , same_list.count)
+        Util.kv('file count - different'  , diff_list.count)
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      def debug_files(heading, files)
+        Util.line(heading)
+        puts files.any? ? files : 'NO FILES'
+      end
+    end
+  end
+end

data/lib/rails_app_generator/diff/processor.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  module Diff
+    # Diff Processor
+    class Processor
+      attr_reader :lhs_path
+      attr_reader :rhs_path
+
+      DEFAULT_EXCLUSION = lambda do |_file, relative_file|
+        relative_file.start_with?('tmp') || relative_file.start_with?('node_modules')
+      end
+
+      def initialize(lhs_path, rhs_path)
+        @lhs_path = lhs_path
+        @rhs_path = rhs_path
+      end
+
+      attr_writer :exclusion_handler
+
+      def compare
+        @info ||= RailsAppGenerator::Diff::CompareInfo.new(
+          lhs_path, file_list(lhs_path),
+          rhs_path, file_list(rhs_path)
+        )
+      end
+
+      def debug
+        compare.debug
+      end
+
+      private
+
+      def exclusion_handler
+        @exclusion_handler ||= DEFAULT_EXCLUSION
+      end
+
+      def file_list(path)
+        prefix_path = path.end_with?('/') ? path : "#{path}/"
+
+        Dir.glob("#{path}/**/*")
+           .reject { |file| File.directory?(file) || exclusion_handler.call(file, file.delete_prefix(prefix_path)) }
+           .map { |file| file.delete_prefix(prefix_path) }
+      end
+
+      # def vscode_compare_files
+      #   files_that_are_different.map do |file|
+      #     system("code --diff #{File.join(lhs_path, file)} #{File.join(rhs_path, file)}")
+      #   end
+      # end
+
+      # private
+
+      # def diff_exclusions(file)
+      #   file.include?('config/credentials.yml.enc') ||
+      #     file.include?('master.key')
+      # end
+    end
+  end
+end

data/lib/rails_app_generator/notes/a2.txt

@@ -74,6 +74,20 @@ create  tmp/cache
 create  tmp/cache/assets
 create  vendor
 create  vendor/.keep
+create  test/fixtures/files
+create  test/fixtures/files/.keep
+create  test/controllers
+create  test/controllers/.keep
+create  test/mailers
+create  test/mailers/.keep
+create  test/models
+create  test/models/.keep
+create  test/helpers
+create  test/helpers/.keep
+create  test/integration
+create  test/integration/.keep
+create  test/channels/application_cable/connection_test.rb
+create  test/test_helper.rb
 create  test/system
 create  test/system/.keep
 create  test/application_system_test_case.rb

data/lib/rails_app_generator/starter.rb

@@ -4,17 +4,6 @@ require 'rails'
 
 require 'rails/generators'
 require 'rails/generators/rails/app/app_generator'
-# require 'active_model/railtie'
-# active_record/railtie
-# active_storage/engine
-# action_controller/railtie
-# action_view/railtie
-# action_mailer/railtie
-# active_job/railtie
-# action_cable/engine
-# action_mailbox/engine
-# action_text/engine
-# rails/test_unit/railtie
 
 module RailsAppGenerator
   #  Starter is a wrapper for Rails::AppGenerator

data/lib/rails_app_generator/util.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RailsAppGenerator
+  # Utility methods
+  class Util
+    class << self
+      # Log KeyValue pair
+      #
+      # @example
+      #   Util.kv(:key, :value)
+      def kv(label, value, len = 35)
+        return ' ' * len if label.nil?
+
+        label = label.to_s if label.is_a?(Symbol)
+        label = label.length > len ? label.slice(0..len) : label.ljust(len, ' ')
+
+        puts "#{label}: #{value}"
+      end
+
+      def line(heading, len = 80)
+        heading = "- [#{heading}]"
+        puts heading.length > len ? heading : heading.ljust(len, '-')
+      end
+    end
+  end
+end

data/lib/rails_app_generator/version.rb

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

data/lib/rails_app_generator.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# require 'k_log'
-
 require 'rails/command/base'
 require 'rails/generators/app_base'
 require 'rails/generators'
@@ -10,6 +8,10 @@ require 'rails/generators/rails/app/app_generator'
 require 'bundler'
 
 require 'rails_app_generator/version'
+require 'rails_app_generator/cli'
+require 'rails_app_generator/util'
+require 'rails_app_generator/diff/compare_info'
+require 'rails_app_generator/diff/processor'
 require 'rails_app_generator/options/base_map_option'
 require 'rails_app_generator/options/map_option_ignore'
 require 'rails_app_generator/options/map_option_string'
@@ -25,15 +27,9 @@ require 'rails_app_generator/app_builder'
 require 'rails_app_generator/app_generator'
 require 'rails_app_generator/starter'
 
-# require "rails_app_generator/generators/base"
-# require "rails_app_generator/generators/foo_generator"
-# require "rails_app_generator/generators/advisories_generator"
-
 module RailsAppGenerator
   # raise RailsAppGenerator::Error, 'Sample message'
   Error = Class.new(StandardError)
-
-  # Your code goes here...
 end
 
 if ENV.fetch('KLUE_DEBUG', 'false').downcase == 'true'

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "rails_app_generator",
-  "version": "0.0.7",
+  "version": "0.0.10",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "rails_app_generator",
-      "version": "0.0.7",
+      "version": "0.0.10",
       "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.7",
+  "version": "0.0.10",
   "description": "Create new Rails Application with custom opinions",
   "scripts": {
     "release": "semantic-release"

data/profiles/rag-bootstrap.json

@@ -5,6 +5,8 @@
   },
   "opts": {
     "skip_git": true,
+    "skip_test": true,
+    "template": "/Users/davidcruwys/dev/kgems/rails_app_generator/after_templates/rag_bootstrap.rb",
     "css": "bootstrap"
   }
 }

data/profiles/rag-simple.json

@@ -5,6 +5,7 @@
   },
   "opts": {
     "skip_git": true,
-    "skip_bundle": true
+    "skip_bundle": true,
+    "template": "/Users/davidcruwys/dev/kgems/rails_app_generator/after_templates/rag_simple.rb"
   }
 }

data/profiles/rag-tailwind.json

@@ -0,0 +1,12 @@
+{
+  "args": {
+    "app_path": "tailwind",
+    "destination_root": "/Users/davidcruwys/dev/kgems/rails_app_generator/a/rag"
+  },
+  "opts": {
+    "skip_git": true,
+    "skip_test": true,
+    "template": "/Users/davidcruwys/dev/kgems/rails_app_generator/after_templates/rag_tailwind.rb",
+    "css": "tailwind"
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_app_generator
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.10
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-22 00:00:00.000000000 Z
+date: 2022-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootsnap
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tailwindcss-rails
+  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'
 - !ruby/object:Gem::Dependency
   name: turbo-rails
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +133,7 @@ files:
 - ".builders/_.rb"
 - ".builders/boot.rb"
 - ".builders/generators/01-bootstrap.rb"
+- ".builders/generators/project-plan.rb"
 - ".releaserc.json"
 - ".rspec"
 - ".rubocop.yml"
@@ -131,9 +146,39 @@ files:
 - README.md
 - Rakefile
 - after_templates/README.md
-- after_templates/test.rb
+- after_templates/___base_template.rb
+- after_templates/___r7_hotwire.rb
+- after_templates/rag_bootstrap.rb
+- after_templates/rag_bootstrap/application-yield.html.erb
+- after_templates/rag_bootstrap/application.html.erb
+- after_templates/rag_bootstrap/component-cards-fancy.css
+- after_templates/rag_bootstrap/component-cards-fancy.html
+- after_templates/rag_bootstrap/component-cards-staff.css
+- after_templates/rag_bootstrap/component-cards-staff.html
+- after_templates/rag_bootstrap/component-cards-styled.html
+- after_templates/rag_bootstrap/component-footer.html
+- after_templates/rag_bootstrap/component-hero.html
+- after_templates/rag_bootstrap/component-nav.html
+- after_templates/rag_bootstrap/custom-bootstrap-import.scss
+- after_templates/rag_bootstrap/custom-using-css.css
+- after_templates/rag_bootstrap/custom-using-scss.scss
+- after_templates/rag_bootstrap/manifest.js
+- after_templates/rag_simple.rb
+- after_templates/rag_tailwind.rb
+- after_templates/rag_tailwind/component-cta.html
+- after_templates/rag_tailwind/component-faq.html
+- after_templates/rag_tailwind/component-footer.html
+- after_templates/rag_tailwind/component-hero.html
+- after_templates/rag_tailwind/component-nav.html
+- after_templates/rag_tailwind/component-section-begin.html
+- after_templates/rag_tailwind/component-section-end.html
 - bin/console
 - bin/setup
+- docs/project-plan.md
+- docs/project-plan/project.drawio
+- docs/project-plan/project_done.svg
+- docs/project-plan/project_in_progress.svg
+- docs/project-plan/project_todo.svg
 - exe/rag
 - lib/rails_app_generator.rb
 - lib/rails_app_generator/add_on.rb
@@ -162,8 +207,11 @@ files:
 - lib/rails_app_generator/addons/views.rb
 - lib/rails_app_generator/app_builder.rb
 - lib/rails_app_generator/app_generator.rb
+- lib/rails_app_generator/cli.rb
 - lib/rails_app_generator/context.rb
 - lib/rails_app_generator/dependencies.rb
+- lib/rails_app_generator/diff/compare_info.rb
+- lib/rails_app_generator/diff/processor.rb
 - lib/rails_app_generator/generators/advisories_generator.rb
 - lib/rails_app_generator/generators/base.rb
 - lib/rails_app_generator/generators/foo_generator.rb
@@ -186,12 +234,14 @@ files:
 - lib/rails_app_generator/options/options_builder.rb
 - lib/rails_app_generator/options/rails_options.rb
 - lib/rails_app_generator/starter.rb
+- lib/rails_app_generator/util.rb
 - lib/rails_app_generator/version.rb
 - package-lock.json
 - package.json
 - profiles/rag-add-some-pages.json
 - profiles/rag-bootstrap.json
 - profiles/rag-simple.json
+- profiles/rag-tailwind.json
 - sig/rails_app_generator.rbs
 - templates/README.md.erb
 - templates/addons/annotate/auto_annotate_models.rake

data/after_templates/test.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require 'pry'
-
-# after_bundle do
-#   setup_rails.after_bundle
-# end
-
-add_scaffold('post', 'title', 'content:text')
-add_scaffold('book', 'title', 'content:text')
-# add_resource("comment", "post:references", 'content:text')
-# add_mailer("posts", "submitted", "broken")