active_model-inherited_partials 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f2ce52b8c1400c27c4710709dd7d9fff4ea752f272442150c4cf5b8e10117a8
+  data.tar.gz: 432e20371935301896f1df236e1f2107efce162fe628965dd621c8e796519aa4
+SHA512:
+  metadata.gz: e38ad659b6607b7cb8b87185d014b11d58f27997648361a026a75ba3e6972ac811f8cc119506abb9a3e55b11c570d4e15249ad00db12a458e1bbfdf343a3ef5a
+  data.tar.gz: dfd3148f9f372b8c6577516b9731687e2a73a10b226f807771d7027ef46003c218dfc354da479733e93caa92b58f0a4f9aa0a67e38f2e8d3ab16af1a7f4b004c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Alexander Senko
+
+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,65 @@
+## Rails partials
+
+Rails partials are great when it comes to rendering a model. But they still seem to have inconsistencies and a room for further improvements.
+
+Consider the following example: we have a model inheritance chain like `Message` → `Message::Text` → `Message::HTML`.
+
+### Issue #1: your code gets WET
+To render both text and HTML messages we need to define both `message/texts/text` & `message/htmls/html` partials — even when they are identical and just rendering `message.title` and `message.body`.
+
+### Issue #2: inconsistent variable naming
+In the above case we get `text` & `html` variables inside the partials, while it's just `message` for the basic `messages/message` one. You can't even copy the identical code from one partial into another!
+
+### Issue #3: inconsistent paths
+Both texts & HTML end up in `views/message`, while the basic message goes to `views/messages`. Thus we get two directories instead of one.
+
+So, meet
+# Inherited Partials
+
+This Rails Engine brings you:
+
+1. **Nesting** directories to respect model namespaces.
+2. Consistent variable **naming** in namespaced partials.
+3. **Inheritance** when a partial is missing.
+
+It provides the above example case with the following partial paths:
+
+```
+messages/message
+messages/text/message
+messages/html/message
+```
+
+When a model's partial is missing, the parent's one is looked up, upto the basic one.
+
+## Usage
+
+No explicit code nor configuration needed, just install it!
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "active_model-inherited_partials"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install active_model-inherited_partials
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## 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/assets/config/active_model_inherited_partials_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/active_model/inherited_partials .css

data/app/assets/stylesheets/active_model/inherited_partials/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/active_model/inherited_partials/application_controller.rb

@@ -0,0 +1,6 @@
+module ActiveModel
+  module InheritedPartials
+    class ApplicationController < ActionController::Base
+    end
+  end
+end

data/app/helpers/active_model/inherited_partials/application_helper.rb

@@ -0,0 +1,6 @@
+module ActiveModel
+  module InheritedPartials
+    module ApplicationHelper
+    end
+  end
+end

data/app/jobs/active_model/inherited_partials/application_job.rb

@@ -0,0 +1,6 @@
+module ActiveModel
+  module InheritedPartials
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/mailers/active_model/inherited_partials/application_mailer.rb

@@ -0,0 +1,8 @@
+module ActiveModel
+  module InheritedPartials
+    class ApplicationMailer < ActionMailer::Base
+      default from: "from@example.com"
+      layout "mailer"
+    end
+  end
+end

data/app/models/active_model/inherited_partials/application_record.rb

@@ -0,0 +1,7 @@
+module ActiveModel
+  module InheritedPartials
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/views/layouts/active_model/inherited_partials/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Active model inherited partials</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "active_model/inherited_partials/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+ActiveModel::InheritedPartials::Engine.routes.draw do
+end

data/lib/active_model/inherited_partials/authors.rb

@@ -0,0 +1,15 @@
+Gem::Author ||= Struct.new(
+		:name,
+		:email,
+		:github_url,
+)
+
+module ActiveModel::InheritedPartials
+	AUTHORS = [
+			Gem::Author.new(
+					name:       'Alexander Senko',
+					email:      'Alexander.Senko@gmail.com',
+					github_url: 'https://github.com/Alexander-Senko',
+			),
+	]
+end

data/lib/active_model/inherited_partials/engine.rb

@@ -0,0 +1,7 @@
+module ActiveModel
+  module InheritedPartials
+    class Engine < ::Rails::Engine
+      isolate_namespace ActiveModel::InheritedPartials
+    end
+  end
+end

data/lib/active_model/inherited_partials/version.rb

@@ -0,0 +1,5 @@
+module ActiveModel
+  module InheritedPartials
+    VERSION = "0.1.0"
+  end
+end

data/lib/active_model/inherited_partials.rb

@@ -0,0 +1,55 @@
+require "active_model/inherited_partials/version"
+require "active_model/inherited_partials/engine"
+
+module ActiveModel
+	module InheritedPartials
+		extend ActiveSupport::Concern
+
+		class_methods do
+			def _to_partial_path
+				@_to_partial_path ||=
+						find_or_inherit namespaced_partial_path || super
+			end
+
+			protected
+
+			def partial_dir  = Pathname(_to_partial_path).dirname
+			def partial_name = Pathname(_to_partial_path).basename.to_s
+
+			private
+
+			def namespaced_partial_path
+				namespace_model
+						&.then { _1.partial_dir / model_name.element / _1.partial_name }
+						&.to_s
+			end
+
+			def namespace_model
+				namespace_classes
+						.reverse.find { _1.respond_to? :model_name }
+			end
+
+			def namespace_classes
+				name
+						.deconstantize
+						.split('::')
+						.map(&:constantize)
+						.select { _1.in? ancestors }
+			end
+
+			def find_or_inherit path
+				return path if partial_exists? path
+				return path if base_class?
+
+				superclass._to_partial_path
+			end
+
+			def partial_exists? path
+				ApplicationController.new.lookup_context
+						.exists? path, [], true
+			end
+		end
+	end
+
+	Conversion::ClassMethods.prepend InheritedPartials::ClassMethods
+end

data/lib/tasks/active_model/inherited_partials_tasks.rake

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

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: active_model-inherited_partials
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Senko
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+description: A Rails Engine to let models inherit partials until overridden.
+email:
+- Alexander.Senko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/active_model_inherited_partials_manifest.js
+- app/assets/stylesheets/active_model/inherited_partials/application.css
+- app/controllers/active_model/inherited_partials/application_controller.rb
+- app/helpers/active_model/inherited_partials/application_helper.rb
+- app/jobs/active_model/inherited_partials/application_job.rb
+- app/mailers/active_model/inherited_partials/application_mailer.rb
+- app/models/active_model/inherited_partials/application_record.rb
+- app/views/layouts/active_model/inherited_partials/application.html.erb
+- config/routes.rb
+- lib/active_model/inherited_partials.rb
+- lib/active_model/inherited_partials/authors.rb
+- lib/active_model/inherited_partials/engine.rb
+- lib/active_model/inherited_partials/version.rb
+- lib/tasks/active_model/inherited_partials_tasks.rake
+homepage: https://github.com/Alexander-Senko/active_model-inherited_partials
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Alexander-Senko/active_model-inherited_partials
+  source_code_uri: https://github.com/Alexander-Senko/active_model-inherited_partials
+  changelog_uri: https://github.com/Alexander-Senko/active_model-inherited_partials/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Inheritable partials for Rails
+test_files: []