action_widget 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1664be8c46748dec0e0b84edf45896f04450cdb71682dca02b403e8208995cdf
-  data.tar.gz: 25f3d481ff1e29b665572cfdcea8a834724c602235aac9344bffda55e616332f
+  metadata.gz: 936309a17ec24cbcbbabbe95f6a2d1348eb938e7ad96ccb95ad94c81a4c00970
+  data.tar.gz: 25c23abdf0674deab60754b91e57cc44daa68484f2e573bb86bb75a255c616f5
 SHA512:
-  metadata.gz: a39e59538ecdfdc4d956713ed5dba9cebeaf61c7556793cf1705c6325e02bb374940e0be1b663e6e43841a0d6a5af66c48e6d7fc94378c62e98b3c11b0530c5a
-  data.tar.gz: cbb6e5e01d7b13fbce76c04cdc38bf26e4454707655b43272ff42f74c15cc652ea91c68b98deed4c5bee309de7c0705a53a8e3b699bb2c048783f971c75e5a61
+  metadata.gz: 22099b7acd486464b24a8cbd18555fe2cff2dd236a885a43dad88a214aa7d47f441285a8d822a934aed64fde7d5490533a70e1722e0cf72bd259d3c2ea25ff7b
+  data.tar.gz: 376888ff223f362a863ef32cdc69d709286fd5439f92fda3dfe7c29698a388f84aeae36431822ce9f0ac7d44b5e869a2b95ecaf8e4a8e763d02129060705011f

data/README.md

@@ -21,17 +21,39 @@ change.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add `ActionWidget` to your application by running
 
-    gem 'action_widget'
+    $ bundle add action_widget
 
-And then execute:
+or install it manually by running:
 
-    $ bundle
+    $ gem install action_widget
 
-Or install it yourself as:
+### Ruby on Rails
 
-    $ gem install action_widget
+If you're working with Ruby on Rails, please run
+
+    $ bin/rails action_widget:install
+
+in addition to one of the above commands to generate the initializer that allows 
+you to configure `ActionWidget`. The resulting initializer will be located at 
+`config/initializers/action_widget.rb` and should look as follows:
+
+```ruby
+ActionWidget.configure do |config|
+  # config.class_prefix = ""
+  config.class_suffix = "Widget"
+
+  # config.helper_prefix = ""
+  config.helper_suffix = "widget"
+
+  config.directory = "widgets"
+end
+```
+
+As shown in the example above, `ActionWidget` allows you to customize
+prefixes and suffixes for class names and helper names, respectively, as well as
+specify the directory name that will house your widgets within the `app/` directory.
 
 ## Usage
 

data/action_widget.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 3.0.0'
 
   gem.add_dependency 'activesupport', '> 6.0'
-  gem.add_dependency 'smart_properties', '~> 1.10'
+  gem.add_dependency 'smart_properties', '~> 1.12'
 
   gem.add_development_dependency 'actionview', '>= 6.0'
   gem.add_development_dependency 'pry'

data/lib/action_widget/base.rb

@@ -18,7 +18,7 @@ module ActionWidget
       super(view, Hash[attributes])
     end
 
-    def render
+    def render(*)
       raise NotImplementedError, "#{self.class} must implement #render"
     end
   end

data/lib/action_widget/configuration.rb

@@ -1,34 +1,25 @@
 module ActionWidget
   class Configuration
     include SmartProperties
-    property :prefix
-    property :suffix
-    property :superclass, required: true, default: -> { ActionWidget::Base }
-    property :directory, required: true, converts: :to_s, accepts: ->(string) { !string.empty? }, default: -> { [underscored_prefix, underscored_suffix].compact.join("_").pluralize }
-    property :minitest_superclass
 
-    attr_reader :pattern
+    property :class_prefix
+    property :class_suffix, default: "Widget"
+    property :helper_prefix
+    property :helper_suffix, default: "widget"
+    property! :superclass, default: "ActionWidget::Base"
+    property! :directory,
+              converts: :to_s,
+              accepts: ->(string) { !string.empty? },
+              default: "widgets"
+    property! :minitest_superclass,
+              default: "ActionView::TestCase"
 
-    def initialize(*)
-      super
-
-      @pattern = Regexp.new("^%s$" % [
-        underscored_prefix,
-        "(.*)",
-        underscored_suffix
-      ].compact.join("_"))
-    end
-
-    private
-
-    def underscored_prefix
-      return if prefix.nil?
-      prefix.underscore
+    def class_pattern
+      Regexp.new("^%s$" % [class_prefix, "(.*?)", class_suffix].compact.join(""))
     end
 
-    def underscored_suffix
-      return if suffix.nil?
-      suffix.underscore
+    def helper_pattern
+      Regexp.new("^%s$" % [helper_prefix, "(.*?)", helper_suffix].compact.join("_"))
     end
   end
 end

data/lib/action_widget/extensions/rails/action_widget_tasks.rake

@@ -0,0 +1,19 @@
+require "rails/generators"
+
+module ActionWidget
+  class InitializerGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../../../../support/templates', __FILE__)
+
+    def create_initializer_file
+      template "initializer.rb.erb", Rails.root.join("config", "initializers", "action_widget.rb")
+    end
+  end
+end
+
+namespace :action_widget do
+  desc "Install"
+  task :install do
+    require_relative './generators'
+    ActionWidget::InitializerGenerator.start
+  end
+end

data/lib/action_widget/extensions/rails/generators.rb

@@ -40,7 +40,7 @@ module ActionWidget
           end
 
           def test_filename
-            "#{helper_name}_test.rb"
+            "#{filename}_test.rb"
           end
 
           def spec_path
@@ -48,7 +48,7 @@ module ActionWidget
           end
 
           def spec_filename
-            "#{helper_name}_spec.rb"
+            "#{filename}_spec.rb"
           end
 
           def implementation_path
@@ -56,11 +56,15 @@ module ActionWidget
           end
 
           def implementation_filename
-            "#{helper_name}.rb"
+            "#{filename}.rb"
+          end
+
+          def filename
+            [configuration.class_prefix&.underscore, basename.underscore, configuration.class_suffix&.underscore].compact.join('_')
           end
 
           def class_name
-            [configuration.prefix, basename.classify, configuration.suffix].join('')
+            [configuration.class_prefix, basename.classify, configuration.class_suffix].compact.join('')
           end
 
           def superclass_name
@@ -68,15 +72,17 @@ module ActionWidget
           end
 
           def minitest_superclass_name
-            (configuration.minitest_superclass || "ActionView::TestCase").to_s
+            configuration.minitest_superclass.to_s
           end
 
           def helper_name
-            class_name.underscore
+            [configuration.helper_prefix, basename.underscore, configuration.helper_suffix].compact.join('_')
           end
 
           def basename
-            if match = name.underscore.match(configuration.pattern)
+            if match = name.match(configuration.class_pattern)
+              match[1]
+            elsif match = name.match(configuration.helper_pattern)
               match[1]
             else
               name

data/lib/action_widget/extensions/rails/railtie.rb

@@ -4,6 +4,10 @@ module ActionWidget
   module Extensions
     module Rails
       class Railtie < ::Rails::Railtie
+        rake_tasks do
+          load File.expand_path("../action_widget_tasks.rake", __FILE__)
+        end
+
         initializer "action_widget.helper" do
           ActiveSupport.on_load(:action_view) do
             include  ActionWidget::ViewHelper

data/lib/action_widget/version.rb

@@ -1,3 +1,3 @@
 module ActionWidget
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

data/lib/action_widget.rb

@@ -12,15 +12,11 @@ module ActionWidget
     end
 
     def configuration
-      @configuration ||= Configuration.new(suffix: "Widget")
+      @configuration ||= Configuration.new
     end
 
     def configure(&block)
-      @configuration = Configuration.new(&block)
-    end
-
-    def helper?(name)
-      !!configuration.pattern.match(name)
+      @configuration = Configuration.new.tap(&block)
     end
 
     protected
@@ -38,9 +34,10 @@ module ActionWidget
     private
 
     def find_action_widget(helper_name)
-      return nil unless helper?(helper_name)
-      basename = configuration.pattern.match(helper_name)[1]
-      classname = [configuration.prefix, basename.camelcase, configuration.suffix].join("")
+      match = configuration.helper_pattern.match(helper_name)
+      return nil if match.nil?
+      basename = match[1]
+      classname = [configuration.class_prefix, basename.classify, configuration.class_suffix].join("")
       classname.constantize
     rescue NameError, LoadError
       nil

data/spec/action_widget_spec.rb

@@ -27,6 +27,10 @@ end
 RSpec.describe DummyWidget do
   let(:view) { ViewContext.empty }
 
+  it "should be registered" do
+    expect(ActionWidget[:dummy_widget]).to be(DummyWidget)
+  end
+
   it "should delegate unknown method calls to the view context" do
     expect(described_class.new(view).render).to eq("<p></p>")
   end
@@ -49,4 +53,26 @@ RSpec.describe DummyWidget do
       expect(instance.options).to eq({class: 'wide'})
     end
   end
+
+  context "with custom configuration" do
+    let(:expected_html) { '<p>Hello World</p>' }
+
+    before do
+      ActionWidget.configure do |config|
+        config.helper_suffix = nil
+      end
+    end
+
+    it "should have an adjusted helper pattern" do
+      expect(ActionWidget.configuration.helper_pattern).to eq(/^(.*?)$/)
+    end
+
+    it "should be possible to override the helper suffix" do
+      expect(view.dummy("Hello World")).to eq(expected_html)
+    end
+
+    after do
+      ActionWidget.configure {}
+    end
+  end
 end

data/support/templates/initializer.rb.erb

@@ -0,0 +1,9 @@
+ActionWidget.configure do |config|
+  # config.class_prefix = nil
+  config.class_suffix = "Widget"
+
+  # config.helper_prefix = nil
+  config.helper_suffix = "widget"
+
+  # config.directory = "widgets"
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: action_widget
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Konstantin Tennhard
 bindir: bin
 cert_chain: []
-date: 2025-03-10 00:00:00.000000000 Z
+date: 2025-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
@@ -183,12 +183,14 @@ files:
 - lib/action_widget/extensions.rb
 - lib/action_widget/extensions/middleman.rb
 - lib/action_widget/extensions/rails.rb
+- lib/action_widget/extensions/rails/action_widget_tasks.rake
 - lib/action_widget/extensions/rails/generators.rb
 - lib/action_widget/extensions/rails/railtie.rb
 - lib/action_widget/version.rb
 - lib/action_widget/view_helper.rb
 - spec/action_widget_spec.rb
 - spec/spec_helper.rb
+- support/templates/initializer.rb.erb
 - support/templates/widget.rb.erb
 - support/templates/widget_spec.rb.erb
 - support/templates/widget_test.rb.erb