magicka 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9431c86cdde2b07ceb2abfd3554f2e40a086df1dc8cfb760dbc7db514db1dcbe
-  data.tar.gz: 30e5f36c63e91fb2a6ce81f25f147b474e6613abeca0446c04cfe96d587cfbbd
+  metadata.gz: 05ffde0ed491999459ac688704b00c0ce07e2c93ae89aaa75f78a1c6b8acabba
+  data.tar.gz: 6d08209c27862a6791917a32e322775bfc801a00dcb666924d7b0b387c92f03b
 SHA512:
-  metadata.gz: ab094ae97de3a63092f2835032152ee71e8747faffef2988540e5ef225b4187d8d688c2578accbccf7e90a7adf02a876bd2b89f847f1a7307d580b552b505a2e
-  data.tar.gz: fc74112bcde8321f00b6fee6e61984c13f80ed280ac4ddbfd2bfff59f824c88cdfe796703e914918b0cbbd3f7e6b47a47e9cff94c875d0da7b920d189b093bd3
+  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.2,0](https://www.rubydoc.info/gems/magicka/0.2.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/config/yardstick.yml

@@ -1,4 +1,4 @@
-threshold: 92.2
+threshold: 85.5
 require_exact_threshold: false
 rules:
   ApiTag::Presence:

data/lib/magicka.rb

@@ -10,9 +10,12 @@ require 'sinclair'
 #
 # module holding herlper to render inputs
 module Magicka
-  autoload :VERSION,       'magicka/version'
-  autoload :Element,       'magicka/element'
-  autoload :Input,         'magicka/input'
-  autoload :InputElement,  'magicka/input_element'
-  autoload :MethodBuilder, 'magicka/method_builder'
+  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/button.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Magicka
+  # Button element representing an HTML +<button/>+
+  class Button < Element
+    with_attribute_locals :ng_click, :ng_disabled, :classes, :text
+    template_folder 'templates/forms'
+  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
 
@@ -76,7 +77,7 @@ module Magicka
     #
     # @return [String]
     def template
-      name.underscore
+      self.class.name.underscore
           .gsub(%r{^.*/}, "#{template_folder}/")
     end
   end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Magicka
+  # Class responsible for controlling one object form
+  class Form < Aggregator
+    attr_reader :model
+
+    def initialize(renderer, model)
+      @renderer = renderer
+      @model    = model
+    end
+
+    with_element(Input)
+    with_element(Select)
+
+    def button(**args)
+      Button.render(renderer: renderer, **args)
+    end
+
+    def with_model(model)
+      new_model = [self.model, model].join('.')
+
+      yield Form.new(renderer, new_model)
+    end
+
+    def equal?(other)
+      return unless other.class == self.class
+
+      other.renderer == renderer &&
+        other.model == model
+    end
+
+    alias == equal?
+
+    protected
+
+    attr_reader :renderer
+
+    delegate :render, to: :renderer
+  end
+end

data/lib/magicka/{input_element.rb → form_element.rb}

@@ -4,11 +4,13 @@ module Magicka
   # @api public
   #
   # Basic class for elements for forms
-  class InputElement < Element
+  class FormElement < Element
     with_attribute_locals :field, :label
     with_attributes :model
     with_locals :ng_errors, :ng_model
 
+    template_folder 'templates/forms'
+
     private
 
     # @api private

data/lib/magicka/input.rb

@@ -2,7 +2,7 @@
 
 module Magicka
   # Input element representing an HTML +<input/>+
-  class Input < InputElement
+  class Input < FormElement
     with_attribute_locals :placeholder
   end
 end

data/lib/magicka/select.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Magicka
+  # Select element representing an HTML +<select/>+
+  class Select < FormElement
+    with_attribute_locals :options
+  end
+end

data/lib/magicka/version.rb

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

data/spec/lib/magicka/button_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Magicka::Button do
+  let(:renderer) { instance_double('renderer') }
+  let(:template) { 'templates/forms/button' }
+
+  let(:ng_click)    { 'controler.click()' }
+  let(:ng_disabled) { 'false' }
+  let(:classes)     { 'custom class' }
+  let(:text)        { 'Click' }
+
+  let(:locals) do
+    {
+      ng_click: ng_click,
+      ng_disabled: ng_disabled,
+      classes: classes,
+      text: text
+    }
+  end
+
+  describe '.render' do
+    let(:arguments) do
+      {
+        renderer: renderer,
+        ng_click: ng_click,
+        ng_disabled: ng_disabled,
+        classes: classes,
+        text: text
+      }
+    end
+
+    before do
+      allow(renderer)
+        .to receive(:render)
+        .with(partial: template, locals: locals)
+    end
+
+    it do
+      described_class.render(arguments)
+
+      expect(renderer).to have_received(:render)
+    end
+
+    context 'when called with extra params' do
+      it do
+        described_class.render(name: 'Name', **arguments)
+
+        expect(renderer).to have_received(:render)
+      end
+    end
+  end
+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/element_spec.rb

@@ -67,12 +67,12 @@ describe Magicka::Element do
     end
 
     context 'when class has only folder defined' do
-      let(:expected_template) { 'templates/forms/input' }
+      let(:expected_template) { 'templates/forms/my_element' }
 
       before do
         klass.template_folder(folder)
 
-        method_builder.add_method(:name) { 'Magicka::Input' }
+        method_builder.add_class_method(:name) { 'Magicka::MyElement' }
         method_builder.build
       end
 

data/spec/lib/magicka/form_element_spec.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Magicka::FormElement do
+  let(:renderer) { instance_double('renderer') }
+  let(:template) { 'templates/forms/custom_template' }
+
+  let(:expected_template) { template }
+
+  let(:model) { :my_model }
+  let(:field) { :field }
+  let(:label) { 'Label' }
+  let(:klass) { Class.new(described_class) }
+
+  let(:locals) do
+    {
+      field: field,
+      label: label,
+      ng_errors: 'my_model.errors.field',
+      ng_model: 'my_model.field'
+    }
+  end
+
+  describe '.render' do
+    let(:arguments) do
+      {
+        renderer: renderer,
+        field: field,
+        label: label,
+        model: model
+      }
+    end
+
+    before do
+      allow(renderer)
+        .to receive(:render)
+        .with(partial: expected_template, locals: locals)
+    end
+
+    context 'when defined template' do
+      before do
+        klass.template(template)
+      end
+
+      it do
+        klass.render(arguments)
+
+        expect(renderer).to have_received(:render)
+      end
+
+      context 'when called with extra params' do
+        it do
+          klass.render(name: 'Name', **arguments)
+
+          expect(renderer).to have_received(:render)
+        end
+      end
+    end
+
+    context 'when not defining a template' do
+      let(:method_builder)    { Sinclair.new(klass) }
+      let(:expected_template) { 'templates/forms/my_custom_element' }
+
+      before do
+        method_builder.add_class_method(:name) do
+          'Magicka::MyCustomElement'
+        end
+        method_builder.build
+      end
+
+      it do
+        klass.render(arguments)
+
+        expect(renderer).to have_received(:render)
+      end
+
+      context 'when called with extra params' do
+        it do
+          klass.render(name: 'Name', **arguments)
+
+          expect(renderer).to have_received(:render)
+        end
+      end
+    end
+  end
+end

data/spec/lib/magicka/form_spec.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Magicka::Form do
+  subject(:form) { described_class.new(renderer, model) }
+
+  let(:model)    { :my_model }
+  let(:renderer) { instance_double('renderer') }
+  let(:template) { 'templates/forms/input' }
+  let(:locals)   { {} }
+
+  before do
+    allow(renderer)
+      .to receive(:render)
+      .with(partial: template, locals: locals)
+  end
+
+  describe '#input' do
+    let(:template)    { 'templates/forms/input' }
+    let(:field)       { :field }
+    let(:label)       { 'Label' }
+    let(:placeholder) { 'Value' }
+
+    let(:locals) do
+      {
+        field: field,
+        label: label,
+        ng_errors: 'my_model.errors.field',
+        ng_model: 'my_model.field',
+        placeholder: placeholder
+      }
+    end
+
+    let(:arguments) do
+      {
+        label: label,
+        placeholder: placeholder
+      }
+    end
+
+    it 'renders an input' do
+      form.input(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',
+          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
+    let(:template)    { 'templates/forms/select' }
+    let(:field)       { :field }
+    let(:label)       { 'Label' }
+    let(:options)     { %i[option_a option_b] }
+
+    let(:locals) do
+      {
+        field: field,
+        label: label,
+        ng_errors: 'my_model.errors.field',
+        ng_model: 'my_model.field',
+        options: options
+      }
+    end
+
+    let(:arguments) do
+      {
+        label: label,
+        options: options
+      }
+    end
+
+    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
+    let(:template)    { 'templates/forms/button' }
+    let(:ng_click)    { 'controler.click()' }
+    let(:ng_disabled) { 'false' }
+    let(:classes)     { 'custom class' }
+    let(:text)        { 'Click' }
+
+    let(:locals) do
+      {
+        ng_click: ng_click,
+        ng_disabled: ng_disabled,
+        classes: classes,
+        text: text
+      }
+    end
+
+    let(:arguments) do
+      {
+        ng_click: ng_click,
+        ng_disabled: ng_disabled,
+        classes: classes,
+        text: text
+      }
+    end
+
+    it 'renders an input' do
+      form.button(arguments)
+
+      expect(renderer).to have_received(:render)
+    end
+  end
+
+  describe '#with_model' do
+    let(:expected_form) { described_class.new(renderer, 'my_model.inner') }
+
+    it do
+      form.with_model(:inner) do |new_form|
+        expect(new_form).to eq(expected_form)
+      end
+    end
+  end
+end

data/spec/lib/magicka/{input_element_spec.rb → select_spec.rb}

@@ -2,34 +2,33 @@
 
 require 'spec_helper'
 
-describe Magicka::InputElement do
+describe Magicka::Select do
   let(:renderer) { instance_double('renderer') }
-  let(:template) { 'templates/forms/input' }
+  let(:template) { 'templates/forms/select' }
 
   let(:model)       { :my_model }
   let(:field)       { :field }
   let(:label)       { 'Label' }
+  let(:options)     { %i[option_a option_b] }
 
   let(:locals) do
     {
       field: field,
       label: label,
       ng_errors: 'my_model.errors.field',
-      ng_model: 'my_model.field'
+      ng_model: 'my_model.field',
+      options: options
     }
   end
 
-  before do
-    described_class.template(template)
-  end
-
   describe '.render' do
     let(:arguments) do
       {
         renderer: renderer,
         field: field,
         label: label,
-        model: model
+        model: model,
+        options: options
       }
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magicka
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2020-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -397,11 +397,16 @@ 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/input_element.rb
-- lib/magicka/method_builder.rb
+- lib/magicka/select.rb
 - lib/magicka/version.rb
 - magicka.gemspec
 - magicka.jpg
@@ -466,11 +471,14 @@ files:
 - spec/dummy/storage/.keep
 - spec/integration/readme/.keep
 - 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/input_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
 - spec/support/shared_examples/.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