magicka 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 662d942d270879b97fb0ee3be36a41c4448db92ab11f2f3462fd4315a53b06d7
-  data.tar.gz: b6dc02755727b9f84ab61dd66eb34d71a8ecac53da565594e49f69c1e632b784
+  metadata.gz: 6bb01a5f327547f6240b632c197db84720e4d4db15cf1c8db5670f22a71c57f7
+  data.tar.gz: 19b15da94bc310d043362e8f11cd10763c169c2ec37d8c04ed1f1b9fd214971c
 SHA512:
-  metadata.gz: 7bad26b83421ea3d47a6d002aa521f754fea7df036ed89ebf457297b076ffc2118bbdaf3fe2465a8cff8e1b3f176ef02dddb0211b20e3b2ab9f0c010b1cf75f6
-  data.tar.gz: ce04771c5649517ee7c17b54978b61137c897e0e23118aac1806b4035ab96aafba6aef857f1cc498048e4ff37b37d0eef433f0133fd871cb364b19cedab5a08a
+  metadata.gz: 84ff51739e85682fba655c81d69217735808c3b450d13a4d26dc9f890a5bbb04f1fc89c107f900b984f8c2d2eaccbfb5b39c3a3f2c8539427bf13b4b93cef244
+  data.tar.gz: 3116e9ed5c060ac7faf810c3f752cded1442bbf745e668f0044ca0a531a5f426943988f12ac7f34e75c1c60e5003ee7e1d314d404e3ca63666a2fa483c1d76f2

data/.rubocop.yml

@@ -4,6 +4,9 @@ inherit_from: .rubocop_todo.yml
 AllCops:
   TargetRubyVersion: 2.7
 
+Layout/LineLength:
+  Max: 90
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*_spec.rb'
@@ -44,3 +47,7 @@ Style/HashTransformKeys:
 
 Style/HashTransformValues:
   Enabled: true
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/integration/**/*_spec.rb'

data/README.md

@@ -12,13 +12,13 @@ Magicka
 Magica helps creating html templates for forms and display data using js applications
 such as AngulaJS
 
-Current Release: [2.0.0](https://github.com/darthjee/magicka/tree/1.0.0)
+Current Release: [1.1.0](https://github.com/darthjee/magicka/tree/1.1.0)
 
-[Next release](https://github.com/darthjee/magicka/compare/1.0.0...master)
+[Next release](https://github.com/darthjee/magicka/compare/1.1.0...master)
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/magicka/1.0.0](https://www.rubydoc.info/gems/magicka/1.0.0)
+[https://www.rubydoc.info/gems/magicka/1.1.0](https://www.rubydoc.info/gems/magicka/1.1.0)
 
 Installation
 ---------------

data/config/check_specs.yml

@@ -1,7 +1,5 @@
 ignore:
   - lib/magicka/version.rb
   - lib/magicka.rb
-  - lib/magicka/aggregator/class_methods.rb
-  - lib/magicka/aggregator/method_builder.rb
   - lib/magicka/helper/class_methods.rb
   - lib/magicka/helper/method_builder.rb

data/config/yardstick.yml

@@ -15,10 +15,16 @@ rules:
     exclude: []
   ExampleTag:
     enabled: true
-    exclude: []
+    exclude:
+      - Magicka::Aggregator#initialize
   ReturnTag:
     enabled: true
-    exclude: []
+    exclude:
+      - Magicka::Form#button
+      - Magicka::Form#select
+      - Magicka::Form#input
+      - Magicka::Display#select
+      - Magicka::Display#input
   Summary::Presence:
     enabled: true
     exclude:

data/lib/magicka/aggregator/method_builder.rb

@@ -6,13 +6,23 @@ module Magicka
     #
     # Class responsible for building an {Aggregator} method
     class MethodBuilder < Sinclair
-      # @param klass [Class.new<Aggregator>]
-      #   Aggragator class to receive the method
-      # @param element_class [Class<Magicka::ELement>]
-      #   Class of the element to be rendered
-      # @param method_name [String,Symbol]
-      #   Name of the method that will render the element
-      # @param template [String] custom template file to be used
+      # @overload initialize(klass, element_class, method_name = nil, template: nil)
+      #   @param element_class [Class<Magicka::Element>]
+      #     Class of the element to be rendered
+      #   @param klass [Class<Aggregator>]
+      #     Aggragator class to receive the method
+      #   @param method_name [String,Symbol]
+      #     Name of the method that will render the element
+      #   @param template [String] custom template file to be used
+      #
+      # @overload initialize(klass, element_class_name, method_name = nil, template: nil)
+      #   @param element_class_name [String]
+      #     String name of Class of the element to be rendered
+      #   @param klass [Class<Aggregator>]
+      #     Aggragator class to receive the method
+      #   @param method_name [String,Symbol]
+      #     Name of the method that will render the element
+      #   @param template [String] custom template file to be used
       def initialize(klass, element_class, method_name = nil, template: nil)
         super(klass)
 
@@ -25,38 +35,35 @@ module Magicka
       #
       # @return [Aggregator::MethodBuilder] return self
       def prepare
-        element_klass = element_class
-        template_file = template
-
-        add_method(method_name) do |field, model: self.model, **args|
-          element_klass.render(
-            renderer: renderer, field: field,
-            model: model, template: template_file,
-            **args
-          )
+        tap do |builder|
+          add_method(method_name) do |field, model: self.model, **args|
+            builder.element_class.render(
+              renderer: renderer, field: field,
+              model: model, template: builder.template,
+              **args
+            )
+          end
         end
-
-        self
       end
 
-      private
-
-      attr_reader :element_class, :template
-      # @method element_class
-      # @api private
-      # @private
-      #
       # Class of the element to be rendered by the method
       #
       # @return [Class<Magicka::Element>]
+      def element_class
+        return @element_class if @element_class.is_a?(Class)
+
+        @element_class = @element_class.constantize
+      end
 
       # @method template
       # @api private
-      # @private
       #
-      # template file
+      # Template file
       #
       # @return [String]
+      attr_reader :template
+
+      private
 
       # name of the method to be generated
       #
@@ -66,7 +73,7 @@ module Magicka
       # @return [String,Symbol]
       def method_name
         @method_name ||= element_class
-                         .name
+                         .to_s
                          .underscore
                          .gsub(%r{.*/}, '')
       end

data/lib/magicka/aggregator.rb

@@ -8,9 +8,7 @@ module Magicka
     autoload :MethodBuilder, 'magicka/aggregator/method_builder'
     autoload :ClassMethods,  'magicka/aggregator/class_methods'
 
-    class << self
-      include Aggregator::ClassMethods
-    end
+    extend Aggregator::ClassMethods
 
     attr_reader :model
     # @method model
@@ -21,14 +19,24 @@ module Magicka
     # @return [String]
 
     # @method self.with_element(element_class, method_name = nil, template: nil)
+    # @api public
     #
     # Configure an {Aggregator} adding a method to render an element
     #
-    # @param element_class [Class<Magicka::ELement>]
-    #   Class of the element to be rendered
-    # @param method_name [String,Symbol]
-    #   Name of the method that will render the element
-    # @param template [String] custom template file to be used
+    # @overload with_element(element_class, method_name = nil, template: nil)
+    #   @param element_class [Class<Magicka::Element>]
+    #     Class of the element to be rendered
+    #   @param method_name [String,Symbol]
+    #     Name of the method that will render the element
+    #   @param template [String] custom template file to be used
+    #
+    # @overload with_element(element_class_name, method_name = nil, template: nil)
+    #   @param element_class_name [String]
+    #     String representation of a class of {Magicka::Element}
+    #     of the element to be rendered
+    #   @param method_name [String,Symbol]
+    #     Name of the method that will render the element
+    #   @param template [String] custom template file to be used
     #
     # @see Aggregator::ClassMethods#with_element
     # @see Aggregator::MethodBuilder

data/lib/magicka/display.rb

@@ -13,7 +13,7 @@ module Magicka
     # Used to not render a button when using
     # display and not form
     #
-    # #return [NilClass]
+    # @return [NilClass]
     def button(**_args); end
 
     # @method input(field, model: self.model, **options)

data/lib/magicka/element/class_methods.rb

@@ -11,6 +11,8 @@ module Magicka
       # @param renderer [Object] object responsible for rendering
       #   the HTML
       # @param args [Hash] Extra options
+      #
+      # @return (see Magicka::Element#render)
       def render(renderer:, **args)
         new(renderer: renderer, **args).render
       end

data/lib/magicka/element.rb

@@ -42,12 +42,14 @@ module Magicka
 
     private
 
-    attr_reader :renderer
     # @api private
     # @private
     # @method renderer
     #
     # Object responsible for rendering the HTML
+    #
+    # @return [ActionView::Base]
+    attr_reader :renderer
 
     # @api private
     # @private
@@ -73,7 +75,7 @@ module Magicka
       end
     end
 
-    # @api public
+    # @api private
     # @private
     #
     # Returns template file location

data/lib/magicka/helper/aggregator_options.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Magicka
+  module Helper
+    # @api private
+    #
+    # Options when generating {Helper} aggregator methods
+    #
+    # This is used when calling {Helper.with Helper.with}
+    class AggregatorOptions < Sinclair::Options
+      with_options :aggregator, :type, :config_block
+
+      # @method config_block
+      # @api private
+      #
+      # Block to be used when configuring a new aggregator class
+      #
+      # @return [Proc]
+
+      # Returns the ready to use aggregator class
+      #
+      # @return [Class<Aggregator>]
+      def configured_aggregator
+        @configured_aggregator ||= configure_aggregator
+      end
+
+      # Type of the aggregator
+      #
+      # Type of aggregator will be used when defining the helper method
+      #
+      # @return [Symbol]
+      def type
+        @type ||= aggregator.type
+      end
+
+      private
+
+      # @private
+      # Configure the aggregator class by running {#config_block}
+      #
+      # @return [Class<Aggregator>]
+      def configure_aggregator
+        klass = aggregator_class
+        return klass unless config_block
+
+        klass.instance_eval(&config_block)
+        klass
+      end
+
+      # @private
+      # Return the aggregator class
+      #
+      # When aggregator class is defined as a String, this is then used to
+      # return the correct class
+      #
+      # @return [Class<Aggregator>]
+      def aggregator_class
+        return aggregator if aggregator.is_a?(Class)
+
+        aggregator.constantize
+      end
+    end
+  end
+end

data/lib/magicka/helper/class_methods.rb

@@ -5,8 +5,16 @@ module Magicka
     # Class methods for {Magicka::Helper}
     module ClassMethods
       # (see Magicka::Helper.with)
-      def with(aggregator_class, type = aggregator_class.type)
-        MethodBuilder.new(self).build_aggregator(aggregator_class, type)
+      def with(aggregator, type = nil, &block)
+        options = AggregatorOptions.new(
+          aggregator: aggregator,
+          type: type,
+          config_block: block
+        )
+
+        MethodBuilder.build(self, options) do
+          build_aggregator
+        end
       end
     end
   end

data/lib/magicka/helper/method_builder.rb

@@ -2,15 +2,19 @@
 
 module Magicka
   module Helper
+    # @api private
+    #
     # Builds methods for {Magicka::Helper}
     class MethodBuilder < Sinclair
-      # (see Magicka::Helper.with)
-      def build_aggregator(aggregator_class, type = aggregator_class.type)
-        add_method("magicka_#{type}") do |model, &block|
-          block.call(aggregator_class.new(self, model))
-        end
+      # Build aggregator helper method
+      #
+      # @return [Array<MethodDefinition>]
+      def build_aggregator
+        opts = options
 
-        build
+        add_method("magicka_#{opts.type}") do |model, &block|
+          block.call(opts.configured_aggregator.new(self, model))
+        end
       end
     end
   end

data/lib/magicka/helper.rb

@@ -1,19 +1,21 @@
 # frozen_string_literal: true
 
 module Magicka
+  # @api public
+  #
   # Helper module to be used on rails
   module Helper
-    autoload :ClassMethods,  'magicka/helper/class_methods'
-    autoload :MethodBuilder, 'magicka/helper/method_builder'
+    autoload :AggregatorOptions, 'magicka/helper/aggregator_options'
+    autoload :ClassMethods,      'magicka/helper/class_methods'
+    autoload :MethodBuilder,     'magicka/helper/method_builder'
 
-    class << self
-      include Helper::ClassMethods
-    end
+    extend Helper::ClassMethods
 
     with Form
     with Display
 
-    # @method self.with(aggregator_class, type = aggregator_class.type)
+    # @method self.with(aggregator_class, type = aggregator_class.type, &config_block)
+    # @api public
     #
     # Adds a helper method magicka_+type+
     #
@@ -23,10 +25,13 @@ module Magicka
     #   Agragator to be initialized
     # @param type [String,Symbol] type of aggregator,
     #   this will define the method name
+    # @param config_block [Proc] block to be evaluated and configure the aggregator
+    #   when it is first used
     #
     # @return [Array<NilClass>]
 
     # @method magicka_form(model)
+    # @api public
     #
     # Execute a block with an aggregator focused on a model
     #
@@ -41,6 +46,7 @@ module Magicka
     # @return [String]
 
     # @method magicka_display(model)
+    # @api public
     #
     # Execute a block with an aggregator focused on a model
     #

data/lib/magicka/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Magicka
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/magicka.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |gem|
   gem.require_paths         = ['lib']
 
   gem.add_runtime_dependency 'activesupport',       '~> 7.0.x'
-  gem.add_runtime_dependency 'sinclair',            '>= 2.0.0'
+  gem.add_runtime_dependency 'sinclair',            '>= 2.0.1'
 
   gem.add_development_dependency 'actionpack',               '7.0.4.3'
   gem.add_development_dependency 'activerecord',             '7.0.4.3'

data/spec/dummy/app/controllers/application_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
 class ApplicationController < ActionController::Base
+  helper Magicka::Helper
 end

data/spec/dummy/app/controllers/documents_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class DocumentsController < ApplicationController
+  def show
+    document = Document.find(params[:id])
+
+    render :show, locals: { document: document }
+  end
+end

data/spec/dummy/app/models/document.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Document < ActiveRecord::Base
+  validates :name, presence: true
+end

data/spec/dummy/app/models/magicka/data_entry.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Magicka
+  class DataEntry < Magicka::Text
+    with_locals :model
+  end
+end

data/spec/dummy/app/models/magicka/data_table.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Magicka
+  class DataTable < Aggregator
+  end
+end

data/spec/dummy/app/views/documents/show.html.erb

@@ -0,0 +1,6 @@
+<dt>
+  <%= magicka_data_table(document) do |table| %>
+    <%= table.data_entry(:name) %>
+    <%= table.data_entry(:reference) %>
+  <% end %>
+</dt>

data/spec/dummy/app/views/templates/display/_data_entry.html.erb

@@ -0,0 +1,2 @@
+<dh><%= label %></dh>
+<dd><%= model.public_send(field) %></dd><br />

data/spec/dummy/config/environments/development.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 Rails.application.configure do
+  config.hosts << 'www.example.com'
   # Settings specified here will take precedence over
   # those in config/application.rb.
 

data/spec/dummy/config/initializers/magicka.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'magicka'
+
+Magicka::Helper.with('Magicka::DataTable', :data_table) do
+  with_element(Magicka::DataEntry)
+end

data/spec/dummy/config/routes.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
 Rails.application.routes.draw do
+  resources :documents
 end

data/spec/dummy/db/schema.rb

@@ -2,4 +2,9 @@
 
 ActiveRecord::Schema.define do
   self.verbose = false
+
+  create_table :documents, force: true do |t|
+    t.string   :name
+    t.string   :reference
+  end
 end

data/spec/integration/yard/magicka/helper_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'yard for Magicka::Helper' do
+  describe '.with' do
+    describe 'when passing only an aggregator' do
+      let(:document) { create(:document) }
+
+      let(:expected_body) do
+        [
+          '<dh>Name</dh>',
+          "<dd>#{document.name}</dd><br />",
+          '',
+          '<dh>Reference</dh>',
+          "<dd>#{document.reference}</dd>"
+        ].join(" *\n *")
+      end
+
+      before { get "/documents/#{document.id}" }
+
+      it do
+        expect(response.status).to eq(200)
+      end
+
+      it do
+        expect(response.body).to match(
+          Regexp.new(expected_body)
+        )
+      end
+    end
+  end
+end