sliders 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68fe0a1c6326b7c9f44c3d68ac87df690a371cedd006ad9ea63e8928381eb71d
-  data.tar.gz: 8c6312ebe8667e00e36af23cff3bba3e016003d5d38d369e3fd4f4bb42d3db30
+  metadata.gz: 92e334f7082b4b266da898f0d116abeb4aed0f62ac1e7a1103aaeb336a40a025
+  data.tar.gz: f87cc0934a9da7fe46da857b1938f224f173d1274e10c7512eb81e43861e09b0
 SHA512:
-  metadata.gz: a30d308fabbf05242057bc284e4b107e6f788e47160c45adbd56bddd90d1d4569e56301d48b4931ae1147bf3e43b7f0ffd70dc42b3aa4139d60edf4d03c5c646
-  data.tar.gz: b7df7a627e6ba3916bc9e9a356ea2037171e6f37acd3d3ad148caefa14841aa1f50b548726cf2596ca97c9a10b358467fb75bd4a8e3c855708ffcec8fad6704b
+  metadata.gz: 0326d5f40aba0722bbf72da10879b04353abbc64d81d2af0ec8b975ee6a2161bd2a7ac7c8ff29430bed9cccfd04b6994bf2755fd88e3162bb5dced50cfe96bf7
+  data.tar.gz: 60e293a699f2d1d7b30727a4a10aac8839357ed70f42d7aea9488da9ec4f58eb00190395ff0040cb94e3db8ca112facbbf352785ef748574cc5acc068669b2f7

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,47 @@ $ 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.
+
+Generators that will now create files in slider folder:
+- controllers
+- scaffold
+- helpers
+- mailers
+- jobs
+- active record model
 
 ## Contributing
-Contribution directions go here.
+Feel free to open PR with fixes for generators for that creates files outside of sliders folder.
 
-### Generators missing
+Known generators that will not do what you expect:
 - view
-- fixtures
-- model (orm)
-- jobs
-- components
-- ...
+  - controller
+  - mailer
+  - scaffold
+- action cable
+- action mailbox
+- tests
+  - controller
+  - model
+  - scaffold
+  - mailer
+  - job
+  - integration
+  - helper
+  - system?
+- fixtures (part of model tests)
+- components?
+
+Other things we need to fix:
+- loading fixtures from slider fixture foldeer
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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")
+    template ".keep", File.join("app/sliders", "#{file_name}", ".keep")
+    template ".keep", 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/rails_ext/active_record_model_generator.rb

@@ -0,0 +1,18 @@
+require "rails/generators/active_record/model/model_generator"
+module SlidersActiveRecordModelGenerator
+  extend ActiveSupport::Concern
+
+  def create_model_file
+    return super unless (class_path & Sliders.sliders).any?
+
+    template "model.rb", File.join("app/sliders/", class_path[0], "models", class_path[1..], "#{file_name}.rb")
+  end
+
+  def create_module_file
+    return super unless (class_path & Sliders.sliders).any?
+
+    return if regular_class_path.empty? || regular_class_path.one?
+    template "module.rb", File.join("app/sliders/", class_path[0], "models", "#{class_path[1..].join('/')}.rb") if behavior == :invoke
+  end
+end
+ActiveRecord::Generators::ModelGenerator.prepend SlidersActiveRecordModelGenerator

data/lib/rails_ext/job_generator.rb

@@ -0,0 +1,11 @@
+require "rails/generators/job/job_generator"
+module SlidersJobGenerator
+  extend ActiveSupport::Concern
+
+  def create_job_file
+    return super unless (class_path & Sliders.sliders).any?
+
+    template "job.rb", File.join("app/sliders/", class_path[0], "jobs", class_path[1..], "#{file_name}_job.rb")
+  end
+end
+Rails::Generators::JobGenerator.prepend SlidersJobGenerator

data/lib/rails_ext/mailer_generator.rb

@@ -0,0 +1,11 @@
+require "rails/generators/mailer/mailer_generator"
+module SlidersMailerGenerator
+  extend ActiveSupport::Concern
+
+  def create_mailer_file
+    return super unless (class_path & Sliders.sliders).any?
+
+    template "mailer.rb", File.join("app/sliders/", class_path[0], "mailers", class_path[1..], "#{file_name}_mailer.rb")
+  end
+end
+Rails::Generators::MailerGenerator.prepend SlidersMailerGenerator

data/lib/sliders/version.rb

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

data/lib/sliders.rb

@@ -4,6 +4,9 @@ require "rails/generators"
 require "rails_ext/controller_generator"
 require "rails_ext/scaffold_controller_generator"
 require "rails_ext/helper_generator"
+require "rails_ext/job_generator"
+require "rails_ext/mailer_generator"
+require "rails_ext/active_record_model_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.2
 platform: ruby
 authors:
 - Simon Træls Ravn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-26 00:00:00.000000000 Z
+date: 2024-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,8 +38,14 @@ files:
 - app/controllers/concerns/fix_sliders_view_path.rb
 - config/initializers/autoloader.rb
 - config/routes.rb
+- lib/generators/slider/USAGE
+- lib/generators/slider/slider_generator.rb
+- lib/generators/slider/templates/module.rb
+- lib/rails_ext/active_record_model_generator.rb
 - lib/rails_ext/controller_generator.rb
 - lib/rails_ext/helper_generator.rb
+- lib/rails_ext/job_generator.rb
+- lib/rails_ext/mailer_generator.rb
 - lib/rails_ext/scaffold_controller_generator.rb
 - lib/sliders.rb
 - lib/sliders/engine.rb