sliders 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 68fe0a1c6326b7c9f44c3d68ac87df690a371cedd006ad9ea63e8928381eb71d
+  data.tar.gz: 8c6312ebe8667e00e36af23cff3bba3e016003d5d38d369e3fd4f4bb42d3db30
+SHA512:
+  metadata.gz: a30d308fabbf05242057bc284e4b107e6f788e47160c45adbd56bddd90d1d4569e56301d48b4931ae1147bf3e43b7f0ffd70dc42b3aa4139d60edf4d03c5c646
+  data.tar.gz: b7df7a627e6ba3916bc9e9a356ea2037171e6f37acd3d3ad148caefa14841aa1f50b548726cf2596ca97c9a10b358467fb75bd4a8e3c855708ffcec8fad6704b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Simon Træls Ravn
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# 🍔 Sliders
+Sliders are mini "app-folders" for grouping related code in your Rails application.
+
+*Like a slider is not really a burger 🍔 this is not really app folders 😉*
+
+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?
+
+With `sliders` you get a namespace folder that groups all you files.
+
+Going from:
+```plain
+app/
+├─ controllers/
+│  └─ my_feature/
+│     ├─ first_controller.rb
+│     └─ second_controller.rb
+├─ models/
+│  └─ my_feature/
+│     ├─ record_a.rb
+│     └─ record_b.rb
+├─ jobs/
+│  └─ my_feature/
+│     └─ run_in_background_job.rb
+└─ interactors/
+   └─ my_feature/
+      └─ important_feature_task.rb
+```
+
+To:
+```plain
+app/
+└─ sliders/
+   └─ my_feature/
+      ├─ controllers/
+      │  ├─ first_controller.rb
+      │  └─ second_controller.rb
+      ├─ models/
+      │  ├─ record_a.rb
+      │  └─ record_b.rb
+      ├─ jobs/
+      │  └─ run_in_background_job.rb
+      └─ interactors/
+         └─ important_feature_task.rb
+```
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "sliders"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Usage
+
+
+## Contributing
+Contribution directions go here.
+
+### Generators missing
+- view
+- fixtures
+- model (orm)
+- jobs
+- components
+- ...
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/concerns/fix_sliders_view_path.rb

@@ -0,0 +1,22 @@
+module FixSlidersViewPath
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :fix_slider_view_path
+  end
+
+  def fix_slider_view_path
+    Dir.glob("#{Rails.root}/app/sliders/*").each do |slice|
+      prepend_view_path ActionView::FileSystemResolver.new(slice + "/views/")
+    end
+  end
+
+  class_methods do
+    def local_prefixes
+      controller_file_path = Object.const_source_location(self.name).first
+      return super unless controller_file_path.include?("#{Rails.root}/app/sliders/")
+
+      [ controller_path, controller_path.gsub("#{self.name.split("::").first.underscore}/", "") ]
+    end
+  end
+end

data/config/initializers/autoloader.rb

@@ -0,0 +1,6 @@
+ActiveSupport::Reloader.to_prepare do
+  # make controllers aware of sliders and adjust view path on slider controllers
+  ApplicationController.include FixSlidersViewPath
+  # reload sliders code and load list of sliders
+  Sliders.reload_sliders
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/rails_ext/controller_generator.rb

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,12 @@
+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

data/lib/sliders/engine.rb

@@ -0,0 +1,4 @@
+module Sliders
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/sliders/version.rb

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

data/lib/sliders.rb

@@ -0,0 +1,26 @@
+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...
+
+  def self.sliders
+    @sliders ||= []
+  end
+
+  def self.reload_sliders
+    @sliders = []
+    Dir.glob("#{Rails.root}/app/sliders/*").each do |slice|
+      next unless File.directory?(slice)
+
+      @sliders << slice.split("/").last
+      Dir.glob("#{slice}/*").each do |path|
+        Rails.autoloaders.main.collapse(path) unless File.file?(path)
+      end
+    end
+  end
+end

data/lib/tasks/sliders_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sliders do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: sliders
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Simon Træls Ravn
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.1
+description: Create app'ish folders to group your features.
+email:
+- traels@traels.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/sliders_manifest.js
+- app/controllers/concerns/fix_sliders_view_path.rb
+- config/initializers/autoloader.rb
+- config/routes.rb
+- lib/rails_ext/controller_generator.rb
+- lib/rails_ext/helper_generator.rb
+- lib/rails_ext/scaffold_controller_generator.rb
+- lib/sliders.rb
+- lib/sliders/engine.rb
+- lib/sliders/version.rb
+- lib/tasks/sliders_tasks.rake
+homepage: https://github.com/traels-it/sliders
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/traels-it/sliders
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Create app'ish folders to group your features.
+test_files: []