sliders 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68fe0a1c6326b7c9f44c3d68ac87df690a371cedd006ad9ea63e8928381eb71d
-  data.tar.gz: 8c6312ebe8667e00e36af23cff3bba3e016003d5d38d369e3fd4f4bb42d3db30
+  metadata.gz: 72c267c97b3ff9cc75bdb8d506a220ee2f71089a3047a6e30e2e4cca28e0dcc3
+  data.tar.gz: afa4127a42b369bac5116d9b3c850270dba2fcfbb8bd4f8988835bbdac926852
 SHA512:
-  metadata.gz: a30d308fabbf05242057bc284e4b107e6f788e47160c45adbd56bddd90d1d4569e56301d48b4931ae1147bf3e43b7f0ffd70dc42b3aa4139d60edf4d03c5c646
-  data.tar.gz: b7df7a627e6ba3916bc9e9a356ea2037171e6f37acd3d3ad148caefa14841aa1f50b548726cf2596ca97c9a10b358467fb75bd4a8e3c855708ffcec8fad6704b
+  metadata.gz: bfd5f6dede68f72d8c66f25988070fe76f8eaa65d14066cc1f760d5200eb409b6f234d4b804233e2269a6de9efa2038fc0d327212d2b957e88a3df00a85c397d
+  data.tar.gz: 2367002ca10751824adaeb3ca85fa699e3f6a08146e41bf83cc3667ee1707cd9f8278ca3bc68e39e4de017ba119f53680c58dd464b095465109791ac24e12459

data/README.md

@@ -6,6 +6,8 @@ Sliders are mini "app-folders" for grouping related code in your Rails applicati
 Some times you have bundles of code in your app that is related to some specific feature.
 Extracting to a gem is not really an option as the feature is tightly integrated with the rest of the application. So how do you get a good structure of files in you application?
 
+(Yes, I've been inspired by, or envious at,  [Hanami](https://github.com/hanami/hanami) and their [slices](https://guides.hanamirb.org/v2.1/app/slices/) for structuring a Hanami application.)
+
 With `sliders` you get a namespace folder that groups all you files.
 
 Going from:
@@ -44,6 +46,7 @@ app/
          └─ important_feature_task.rb
 ```
 
+Future plan is to group all your sliders tests in a `test/sliders/my_feature` folder as well.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -58,18 +61,25 @@ $ bundle
 ```
 
 ## Usage
+Create your slider folder
+```bash
+$ rails g slider my_feature
+```
+
+This creates the `app/sliders/` folder and a module and folder for your feature.
 
+Now you can just use regular generators to create thing in `MyFeature` namespace and *sliders* will create the files in your slider folder.
+
+The folder *sliders* is not used for namespace, just like the folders in your slider is not used. So a file in `app/sliders/my_feature/models/admin.rb` will be for the constant `MyFeature::Admin`.
 
 ## Contributing
-Contribution directions go here.
-
-### Generators missing
-- view
-- fixtures
-- model (orm)
-- jobs
-- components
-- ...
+PR with fixes or improvements are most welcome.
+
+We have tested *sliders* with most of Rails built-in generators, only a few of them have actual test cases.
+PR with tests for more generators are very welcome - also generators for often used gems like eg. ViewComponent or Rspec.
+
+**Known bugs**
+- fixtures are generated in *sliders* folder, so they will not work
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/config/initializers/generators.rb

@@ -0,0 +1,91 @@
+module SlidersCopyInvoke
+  extend ActiveSupport::Concern
+
+  included do
+    class << self
+      alias_method :original_invoke, :invoke
+      alias_method :original_run_after_generate_callback, :run_after_generate_callback
+    end
+  end
+end
+Rails::Generators.include SlidersCopyInvoke
+
+module SlidersInvoke
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def invoke(namespace, args = ARGV, config = {})
+      # warn "SLIDERS INVOKE: #{namespace} #{args} #{config}"
+      original_invoke(namespace, args, config)
+
+      names = namespace.to_s.split(":")
+      if find_by_namespace(names.pop, names.any? && names.join(":"))
+        sliders_cleanup if config[:behavior] == :revoke
+        sliders_move if config[:behavior] == :invoke
+      end
+    end
+
+    private
+
+    def sliders_cleanup
+      loop_files(class_variable_get(:@@generated_files)) do |source_file, destination_file|
+        File.unlink destination_file
+      end
+    end
+
+    def sliders_move
+      loop_files(class_variable_get(:@@sliders_generated_files)) do |source_file, destination_file|
+        source_file = Rails.root.join(source_file)
+        FileUtils.mkdir_p(File.dirname(destination_file))
+        FileUtils.mv(source_file, destination_file)
+      end
+
+      class_variable_set(:@@sliders_generated_files, [])
+    end
+
+    def loop_files(source_files)
+      source_files.each do |source_file|
+        slider = Sliders.sliders.find { |slider| source_file.include? slider }
+        next unless slider
+
+        destination_file = file_in_slider_path(source_file, slider)
+        next unless destination_file
+
+        yield source_file, destination_file
+      end
+    end
+
+    def file_in_slider_path(source_file, slider)
+      path_parts = source_file.split("/")
+      return unless path_parts.include?(slider) || path_parts.include?("#{slider}.rb")
+      return unless path_parts.include?("app") || path_parts.include?("test")
+
+      # add sliders after app or test
+      path_parts.insert(path_parts.index("app") + 1, "sliders") if path_parts.include?("app")
+      path_parts.insert(path_parts.index("test") + 1, "sliders") if path_parts.include?("test")
+
+      # move slider namespace up or add if file is named like #{slider}.rb
+      if path_parts.include?(slider)
+        slider_namespace_index = path_parts.index(slider)
+        path_parts[slider_namespace_index], path_parts[slider_namespace_index - 1] = path_parts[slider_namespace_index - 1], path_parts[slider_namespace_index]
+      else
+        path_parts.insert(path_parts.index("sliders") + 1, slider)
+      end
+
+      Rails.root.join(path_parts.join("/"))
+    rescue StandardError => e
+      warn "===== Sliders Error ====="
+      warn "Error moving file: #{source_file} for slider: #{slider}"
+      warn "Error: #{e.message}"
+      warn "========================="
+      raise
+    end
+
+    def run_after_generate_callback
+      class_variable_set(:@@sliders_generated_files, [])
+      class_variable_set(:@@sliders_generated_files, class_variable_get(:@@generated_files)) if class_variable_defined?(:@@generated_files)
+      original_run_after_generate_callback
+    end
+  end
+end
+Rails::Generators.prepend SlidersInvoke

data/lib/generators/slider/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Creates basic slider folder structure
+
+Example:
+    bin/rails generate slider Thing
+
+    This will create:
+        app/sliders/thing
+        test/sliders/thing

data/lib/generators/slider/slider_generator.rb

@@ -0,0 +1,9 @@
+class SliderGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+
+  def create_slider_file
+    template "module.rb", File.join("app/sliders", "#{file_name}.rb")
+    create_file File.join("app/sliders", "#{file_name}", ".keep"), ""
+    create_file File.join("test/sliders", "#{file_name}", ".keep"), ""
+  end
+end

data/lib/generators/slider/templates/module.rb

@@ -0,0 +1,2 @@
+module <%= class_name %>
+end

data/lib/sliders/version.rb

@@ -1,3 +1,3 @@
 module Sliders
-  VERSION = "0.1.0"
+  VERSION = "0.1.3"
 end

data/lib/sliders.rb

@@ -1,9 +1,6 @@
 require "sliders/version"
 require "sliders/engine"
 require "rails/generators"
-require "rails_ext/controller_generator"
-require "rails_ext/scaffold_controller_generator"
-require "rails_ext/helper_generator"
 
 module Sliders
   # Your code goes here...

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sliders
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Simon Træls Ravn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-26 00:00:00.000000000 Z
+date: 2025-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -37,10 +37,11 @@ files:
 - app/assets/config/sliders_manifest.js
 - app/controllers/concerns/fix_sliders_view_path.rb
 - config/initializers/autoloader.rb
+- config/initializers/generators.rb
 - config/routes.rb
-- lib/rails_ext/controller_generator.rb
-- lib/rails_ext/helper_generator.rb
-- lib/rails_ext/scaffold_controller_generator.rb
+- lib/generators/slider/USAGE
+- lib/generators/slider/slider_generator.rb
+- lib/generators/slider/templates/module.rb
 - lib/sliders.rb
 - lib/sliders/engine.rb
 - lib/sliders/version.rb

data/lib/rails_ext/controller_generator.rb

@@ -1,11 +0,0 @@
-require "rails/generators/rails/controller/controller_generator"
-module SlidersControllerGenerator
-  extend ActiveSupport::Concern
-
-  def create_controller_files
-    return super unless (class_path & Sliders.sliders).any?
-
-    template "controller.rb", File.join("app/sliders/", class_path[0], "controllers", class_path[1..], "#{file_name}_controller.rb")
-  end
-end
-Rails::Generators::ControllerGenerator.prepend SlidersControllerGenerator

data/lib/rails_ext/helper_generator.rb

@@ -1,11 +0,0 @@
-require "rails/generators/rails/helper/helper_generator"
-module SlidersHelperGenerator
-  extend ActiveSupport::Concern
-
-  def create_helper_files
-    return super unless (class_path & Sliders.sliders).any?
-
-    template "helper.rb", File.join("app/sliders/", class_path[0], "helpers", class_path[1..], "#{file_name}_helper.rb")
-  end
-end
-Rails::Generators::HelperGenerator.prepend SlidersHelperGenerator

data/lib/rails_ext/scaffold_controller_generator.rb

@@ -1,12 +0,0 @@
-require "rails/generators/rails/scaffold_controller/scaffold_controller_generator"
-module SlidersScaffoldControllerGenerator
-  extend ActiveSupport::Concern
-
-  def create_controller_files
-    return super unless (controller_class_path & Sliders.sliders).any?
-
-    template_file = options.api? ? "api_controller.rb" : "controller.rb"
-    template template_file, File.join("app/sliders/", controller_class_path[0], "controllers", controller_class_path[1..], "#{controller_file_name}_controller.rb")
-  end
-end
-Rails::Generators::ScaffoldControllerGenerator.prepend SlidersScaffoldControllerGenerator