magicka 0.3.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7939778de2faac419e42a17986de873d7cbefa0b65531dcc968f697411e0ee7a
-  data.tar.gz: 831909938f84d296ba8706893b13c5ef7bf9f5b16e2d57cb10986e83151a2ed3
+  metadata.gz: 790574b274384507133ba81bff57316fdee267695e6a86bbb36da2065d98f918
+  data.tar.gz: ded516626da7b9825e1711aa4d299cd0388de7293776cc20c9facc607b4ba8ef
 SHA512:
-  metadata.gz: 74b61fb09691f38d280b08adde917d838866b918f23d4b9a530bf0f43cd22d8c963980bd5e02de23b89e601bbb708fd374da6e5285e7507d33e1b319fe9937a7
-  data.tar.gz: 8a263ca1eb2a0fc180e4fdc9eff054aede6452e19819d788b1e6c3f203875104ea177c1f2b8d38b14d5909d506528fb2a621fcdb4aafe9ab7ff49513bac3509e
+  metadata.gz: a2fb23dfa2dca070216bede19831ca54bc0c9ee1340418848e647512d4ec7668ee97b0015aa8d7d3b85e6014883e263107ce8360efed4286342e714f502d93ce
+  data.tar.gz: 6e165bd37c83eb5d3c0c760164f2f93e9d51d05f284621960012e24b81d5b7779140cca6f1d47128bd24a4545201e77becd489fa20d9e0ac6ba816cd01dc8fdf

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.3.1](https://www.rubydoc.info/gems/magicka/0.3.1)
+[https://www.rubydoc.info/gems/magicka/0.5.3](https://www.rubydoc.info/gems/magicka/0.5.3)
 
 Installation
 ---------------

data/config/check_specs.yml

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

data/config/yardstick.yml

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

data/lib/magicka.rb

@@ -10,11 +10,15 @@ 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 :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 :Display,     'magicka/display'
+  autoload :Element,     'magicka/element'
+  autoload :FormElement, 'magicka/form_element'
+  autoload :Form,        'magicka/form'
+  autoload :Helper,      'magicka/helper'
+  autoload :Input,       'magicka/input'
+  autoload :Select,      'magicka/select'
+  autoload :Text,        'magicka/text'
 end

data/lib/magicka/aggregator.rb

@@ -0,0 +1,47 @@
+# 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
+
+    attr_reader :model
+
+    def initialize(renderer, model)
+      @renderer = renderer
+      @model    = model
+    end
+
+    def with_model(model, base: self.model)
+      new_model = [base, model].compact.join('.')
+
+      yield self.class.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/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/display.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Magicka
+  # Class responsible for controlling one object display
+  class Display < Aggregator
+    with_element(Text, :input)
+    with_element(Text, :select)
+
+    def button(**_args); 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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Magicka
+  # Class responsible for controlling one object form
+  class Form < Aggregator
+    with_element(Input)
+    with_element(Select)
+
+    def button(**args)
+      Button.render(renderer: renderer, **args)
+    end
+  end
+end

data/lib/magicka/helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Magicka
+  # Helper module to be used on rails
+  module Helper
+    def magicka_form(model)
+      yield Form.new(self, model)
+    end
+
+    def magicka_display(model)
+      yield Display.new(self, model)
+    end
+  end
+end

data/lib/magicka/text.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Magicka
+  # Input element representing an HTML +<input/>+
+  class Text < FormElement
+    template_folder 'templates/display'
+  end
+end

data/lib/magicka/version.rb

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

data/spec/lib/magicka/display_spec.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Magicka::Display do
+  subject(:form) { described_class.new(renderer, model) }
+
+  let(:model)    { :my_model }
+  let(:renderer) { instance_double('renderer') }
+  let(:template) { 'templates/display/text' }
+  let(:locals)   { {} }
+
+  before do
+    allow(renderer)
+      .to receive(:render)
+      .with(partial: template, locals: locals)
+  end
+
+  describe '#input' do
+    let(:template)    { 'templates/display/text' }
+    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'
+      }
+    end
+
+    let(:arguments) do
+      {
+        label: label,
+        placeholder: placeholder
+      }
+    end
+
+    it 'renders a text' 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'
+        }
+      end
+
+      it 'renders a text' do
+        form.input(field, model: 'my_custom_model', **arguments)
+
+        expect(renderer).to have_received(:render)
+      end
+    end
+  end
+
+  describe '#select' do
+    let(:template)    { 'templates/display/text' }
+    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'
+      }
+    end
+
+    let(:arguments) do
+      {
+        label: label,
+        options: options
+      }
+    end
+
+    it 'renders a text' 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'
+        }
+      end
+
+      it 'renders a text' do
+        form.select(field, model: 'my_custom_model', **arguments)
+
+        expect(renderer).to have_received(:render)
+      end
+    end
+  end
+
+  describe '#button' do
+    let(:ng_click)    { 'controler.click()' }
+    let(:ng_disabled) { 'false' }
+    let(:classes)     { 'custom class' }
+    let(:text)        { 'Click' }
+
+    let(:arguments) do
+      {
+        ng_click: ng_click,
+        ng_disabled: ng_disabled,
+        classes: classes,
+        text: text
+      }
+    end
+
+    it 'renders nothing' do
+      form.button(arguments)
+
+      expect(renderer).not_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
+
+  describe '#with_form' do
+    it do
+      form.with_model('sub') do |new_form|
+        expect(new_form)
+          .to eq(described_class.new(renderer, 'my_model.sub'))
+      end
+    end
+
+    context 'when passing a new base' do
+      it do
+        form.with_model('sub', base: :other_model) do |new_form|
+          expect(new_form)
+            .to eq(described_class.new(renderer, 'other_model.sub'))
+        end
+      end
+    end
+
+    context 'when passing an empty base' do
+      it do
+        form.with_model('sub', base: nil) do |new_form|
+          expect(new_form)
+            .to eq(described_class.new(renderer, 'sub'))
+        end
+      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/form_spec.rb

@@ -0,0 +1,183 @@
+# 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
+
+  describe '#with_form' do
+    it do
+      form.with_model('sub') do |new_form|
+        expect(new_form)
+          .to eq(described_class.new(renderer, 'my_model.sub'))
+      end
+    end
+
+    context 'when passing a new base' do
+      it do
+        form.with_model('sub', base: :other_model) do |new_form|
+          expect(new_form)
+            .to eq(described_class.new(renderer, 'other_model.sub'))
+        end
+      end
+    end
+
+    context 'when passing an empty base' do
+      it do
+        form.with_model('sub', base: nil) do |new_form|
+          expect(new_form)
+            .to eq(described_class.new(renderer, 'sub'))
+        end
+      end
+    end
+  end
+end

data/spec/lib/magicka/text_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Magicka::Text do
+  let(:renderer) { instance_double('renderer') }
+  let(:template) { 'templates/display/text' }
+
+  let(:model) { :my_model }
+  let(:field) { :field }
+  let(:label) { 'Label' }
+
+  let(:locals) do
+    {
+      field: field,
+      label: label,
+      ng_model: 'my_model.field',
+      ng_errors: 'my_model.errors.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: 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magicka
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.3
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-03 00:00:00.000000000 Z
+date: 2020-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -397,13 +397,19 @@ 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/display.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/helper.rb
 - lib/magicka/input.rb
-- lib/magicka/method_builder.rb
 - lib/magicka/select.rb
+- lib/magicka/text.rb
 - lib/magicka/version.rb
 - magicka.gemspec
 - magicka.jpg
@@ -469,12 +475,15 @@ files:
 - spec/integration/readme/.keep
 - spec/integration/yard/.keep
 - spec/lib/magicka/button_spec.rb
+- spec/lib/magicka/display_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/lib/magicka/text_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