magicka 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81717f300e575454157f07d2e37f93b68a43aee24374cc84d49142f3815b26de
-  data.tar.gz: f50c9807efb97e1fa9719f010c39d261eb6fe9ccf12d3a199c33521b515ea2ae
+  metadata.gz: 05ffde0ed491999459ac688704b00c0ce07e2c93ae89aaa75f78a1c6b8acabba
+  data.tar.gz: 6d08209c27862a6791917a32e322775bfc801a00dcb666924d7b0b387c92f03b
 SHA512:
-  metadata.gz: ede839d74d03176271d66aaf5ac672cdf0774e3be38edcf7306414de16f64fea51f73b3390c184f684c1c9189978bc045d51f8f0a1dc7d5e408432fd7b3863fa
-  data.tar.gz: e67ed028a79ef8dbfdb1ed0c16e592df1749941429002cc5f83522bb744b16a20fee771004326a853165d25d11beb7376bd7fee5243d4e398556426c256e1fcd
+  metadata.gz: 4d2aa6d343fe5104e275dc9257fb838c650f0353406452b217fb17f40978ea4152838c56181300bec3f1da208f28764790e947619f5137426545206c540e5952
+  data.tar.gz: 91036aeff9fbefe61eacc3b93005e8f51e9c6cf86ce7cb618e5360ea8059c7ba6df680c4bd5cebf9c57cb3a8154058b63aa1aeb1c362261b4613e4707cf41ca0

data/.circleci/config.yml

@@ -7,8 +7,12 @@ workflows:
           filters:
             tags:
               only: /.*/
+      - checks:
+          filters:
+            tags:
+              only: /.*/
       - build-and-release:
-          requires: [test]
+          requires: [test, checks]
           filters:
             tags:
               only: /\d+\.\d+\.\d+/
@@ -18,7 +22,7 @@ workflows:
 jobs:
   test:
     docker:
-      - image: darthjee/circleci_rails_gems:0.5.4
+      - image: darthjee/circleci_rails_gems:0.6.0
         environment:
           PROJECT: magicka
     steps:
@@ -32,12 +36,22 @@ jobs:
       - run:
           name: RSpec
           command: bundle exec rspec
-      - run:
-          name: Rubocop
-          command: rubocop
       - run:
           name: Coverage Test Report
           command: cc-test-reporter after-build --exit-code $?
+  checks:
+    docker:
+      - image: darthjee/circleci_rails_gems:0.6.0
+        environment:
+          PROJECT: magicka
+    steps:
+      - checkout
+      - run:
+          name: Bundle Install
+          command: bundle install
+      - run:
+          name: Rubocop
+          command: rubocop
       - run:
           name: Yardstick coverage check
           command: bundle exec rake verify_measurements

data/README.md

@@ -11,7 +11,7 @@ Magicka
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/magicka/0.4.0](https://www.rubydoc.info/gems/magicka/0.4.0)
+[https://www.rubydoc.info/gems/magicka/0.5.0](https://www.rubydoc.info/gems/magicka/0.5.0)
 
 Installation
 ---------------

data/config/check_specs.yml

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

data/lib/magicka.rb

@@ -10,12 +10,12 @@ require 'sinclair'
 #
 # module holding herlper to render inputs
 module Magicka
-  autoload :VERSION,       'magicka/version'
-  autoload :Button,        'magicka/button'
-  autoload :Element,       'magicka/element'
-  autoload :FormElement,   'magicka/form_element'
-  autoload :Form,          'magicka/form'
-  autoload :Input,         'magicka/input'
-  autoload :MethodBuilder, 'magicka/method_builder'
-  autoload :Select,        'magicka/select'
+  autoload :VERSION,     'magicka/version'
+  autoload :Aggregator,  'magicka/aggregator'
+  autoload :Button,      'magicka/button'
+  autoload :Element,     'magicka/element'
+  autoload :FormElement, 'magicka/form_element'
+  autoload :Form,        'magicka/form'
+  autoload :Input,       'magicka/input'
+  autoload :Select,      'magicka/select'
 end

data/lib/magicka/aggregator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Magicka
+  # @api public
+  #
+  # Class representing an element agregator, representing a model
+  class Aggregator
+    autoload :MethodBuilder, 'magicka/aggregator/method_builder'
+
+    class << self
+      def with_element(element_class, method_name = nil)
+        MethodBuilder
+          .new(self, element_class, method_name)
+          .prepare
+          .build
+      end
+    end
+  end
+end

data/lib/magicka/aggregator/method_builder.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Magicka
+  class Aggregator
+    # @api private
+    #
+    # Class responsible for building an {Aggregator} method
+    class MethodBuilder < Sinclair
+      def initialize(klass, element_class, method_name = nil)
+        super(klass)
+
+        @element_class = element_class
+        @method_name = method_name
+      end
+
+      def prepare
+        element_klass = element_class
+
+        add_method(method_name) do |field, model: self.model, **args|
+          element_klass.render(
+            renderer: renderer, field: field, model: model, **args
+          )
+        end
+
+        self
+      end
+
+      private
+
+      attr_reader :element_class
+
+      def method_name
+        @method_name ||= element_class
+                         .name
+                         .underscore
+                         .gsub(%r{.*/}, '')
+      end
+    end
+  end
+end

data/lib/magicka/element.rb

@@ -5,7 +5,8 @@ module Magicka
   #
   # Base class for element rendering
   class Element < Sinclair::Options
-    autoload :ClassMethods, 'magicka/element/class_methods'
+    autoload :ClassMethods,  'magicka/element/class_methods'
+    autoload :MethodBuilder, 'magicka/element/method_builder'
 
     skip_validation
 

data/lib/magicka/element/method_builder.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Magicka
+  class Element
+    # @api private
+    #
+    # class responsible for building methods on {Magicka::Element}
+    class MethodBuilder < Sinclair
+      # adds a mehtod +#template+
+      #
+      # The method will always return the template given in the params
+      #
+      # @param template [String] path to template file
+      #
+      # @return [Array<Sinclair::MethodDefinition>]
+      def add_template(template)
+        add_method(:template) do
+          template
+        end
+
+        build
+      end
+
+      # adds a mehtod +#template_folder+
+      #
+      # The method will always return the template folder given in the params
+      #
+      # @param template_folder [String] path to template folder
+      #
+      # @return [Array<Sinclair::MethodDefinition>]
+      def add_template_folder(folder)
+        add_method(:template_folder) do
+          folder
+        end
+
+        build
+      end
+    end
+  end
+end

data/lib/magicka/form.rb

@@ -2,7 +2,7 @@
 
 module Magicka
   # Class responsible for controlling one object form
-  class Form
+  class Form < Aggregator
     attr_reader :model
 
     def initialize(renderer, model)
@@ -10,13 +10,8 @@ module Magicka
       @model    = model
     end
 
-    def input(field, model: self.model, **args)
-      Input.render(renderer: renderer, field: field, model: model, **args)
-    end
-
-    def select(field, model: self.model, **args)
-      Select.render(renderer: renderer, field: field, model: model, **args)
-    end
+    with_element(Input)
+    with_element(Select)
 
     def button(**args)
       Button.render(renderer: renderer, **args)

data/lib/magicka/version.rb

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

data/spec/lib/magicka/{method_builder_spec.rb → element/method_builder_spec.rb}

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe Magicka::MethodBuilder do
+describe Magicka::Element::MethodBuilder do
   subject(:builder) { described_class.new(klass) }
 
   let(:klass)    { Class.new }

data/spec/lib/magicka/form_spec.rb

@@ -35,8 +35,7 @@ describe Magicka::Form do
     let(:arguments) do
       {
         label: label,
-        placeholder: placeholder,
-        model: model
+        placeholder: placeholder
       }
     end
 
@@ -45,6 +44,24 @@ describe Magicka::Form do
 
       expect(renderer).to have_received(:render)
     end
+
+    context 'when passing a custom model' do
+      let(:locals) do
+        {
+          field: field,
+          label: label,
+          ng_errors: 'my_custom_model.errors.field',
+          ng_model: 'my_custom_model.field',
+          placeholder: placeholder
+        }
+      end
+
+      it 'renders an input' do
+        form.input(field, model: 'my_custom_model', **arguments)
+
+        expect(renderer).to have_received(:render)
+      end
+    end
   end
 
   describe '#select' do
@@ -66,16 +83,33 @@ describe Magicka::Form do
     let(:arguments) do
       {
         label: label,
-        model: model,
         options: options
       }
     end
 
-    it 'renders an input' do
+    it 'renders a select' do
       form.select(field, arguments)
 
       expect(renderer).to have_received(:render)
     end
+
+    context 'when passing a custom model' do
+      let(:locals) do
+        {
+          field: field,
+          label: label,
+          ng_errors: 'my_custom_model.errors.field',
+          ng_model: 'my_custom_model.field',
+          options: options
+        }
+      end
+
+      it 'renders a select' do
+        form.select(field, model: 'my_custom_model', **arguments)
+
+        expect(renderer).to have_received(:render)
+      end
+    end
   end
 
   describe '#button' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magicka
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - DarthJee
@@ -397,13 +397,15 @@ files:
 - config/yardstick.yml
 - docker-compose.yml
 - lib/magicka.rb
+- lib/magicka/aggregator.rb
+- lib/magicka/aggregator/method_builder.rb
 - lib/magicka/button.rb
 - lib/magicka/element.rb
 - lib/magicka/element/class_methods.rb
+- lib/magicka/element/method_builder.rb
 - lib/magicka/form.rb
 - lib/magicka/form_element.rb
 - lib/magicka/input.rb
-- lib/magicka/method_builder.rb
 - lib/magicka/select.rb
 - lib/magicka/version.rb
 - magicka.gemspec
@@ -471,11 +473,11 @@ files:
 - spec/integration/yard/.keep
 - spec/lib/magicka/button_spec.rb
 - spec/lib/magicka/element/class_methods_spec.rb
+- spec/lib/magicka/element/method_builder_spec.rb
 - spec/lib/magicka/element_spec.rb
 - spec/lib/magicka/form_element_spec.rb
 - spec/lib/magicka/form_spec.rb
 - spec/lib/magicka/input_spec.rb
-- spec/lib/magicka/method_builder_spec.rb
 - spec/lib/magicka/select_spec.rb
 - spec/spec_helper.rb
 - spec/support/models/.keep

data/lib/magicka/method_builder.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Magicka
-  # @api private
-  #
-  # class responsible for building methods on {Magicka::Element}
-  class MethodBuilder < Sinclair
-    # adds a mehtod +#template+
-    #
-    # The method will always return the template given in the params
-    #
-    # @param template [String] path to template file
-    #
-    # @return [Array<Sinclair::MethodDefinition>]
-    def add_template(template)
-      add_method(:template) do
-        template
-      end
-
-      build
-    end
-
-    # adds a mehtod +#template_folder+
-    #
-    # The method will always return the template folder given in the params
-    #
-    # @param template_folder [String] path to template folder
-    #
-    # @return [Array<Sinclair::MethodDefinition>]
-    def add_template_folder(folder)
-      add_method(:template_folder) do
-        folder
-      end
-
-      build
-    end
-  end
-end