magicka 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb9d51d1218f32ac849193da117869a8bbc8bfa51f8cb2f8c7eb3c4845309200
-  data.tar.gz: e6728fa98edd29a39de7c53497e542496468006f7c5902f112b3860835f2579d
+  metadata.gz: 9431c86cdde2b07ceb2abfd3554f2e40a086df1dc8cfb760dbc7db514db1dcbe
+  data.tar.gz: 30e5f36c63e91fb2a6ce81f25f147b474e6613abeca0446c04cfe96d587cfbbd
 SHA512:
-  metadata.gz: 07b9a25dd6fd4bb5d978a0d1a8f20e94320735b288ad469f31a2c31331f146f6b0f7c9ef54294d171e87732af3090e3093f7b04785a165ebf89d59f4e9ffb09a
-  data.tar.gz: 0da01e6080f9c53033dd44ff44f1fe37e442c27875f477d2c16005c3f17fe604a2206c3e10cf20d20b3a0732ca8ac4eb56226f3ac8294ed41604864173632e94
+  metadata.gz: ab094ae97de3a63092f2835032152ee71e8747faffef2988540e5ef225b4187d8d688c2578accbccf7e90a7adf02a876bd2b89f847f1a7307d580b552b505a2e
+  data.tar.gz: fc74112bcde8321f00b6fee6e61984c13f80ed280ac4ddbfd2bfff59f824c88cdfe796703e914918b0cbbd3f7e6b47a47e9cff94c875d0da7b920d189b093bd3

data/Dockerfile

@@ -1,6 +1,6 @@
 FROM darthjee/scripts:0.1.8 as scripts
 
-FROM darthjee/rails_gems:0.5.4 as base
+FROM darthjee/rails_gems:0.6.0 as base
 
 COPY --chown=app:app ./ /home/app/app/
 

data/README.md

@@ -11,7 +11,7 @@ Magicka
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/magicka/0.1,0](https://www.rubydoc.info/gems/magicka/0.1.0)
+[https://www.rubydoc.info/gems/magicka/0.2,0](https://www.rubydoc.info/gems/magicka/0.2.0)
 
 Installation
 ---------------

data/config/yardstick.yml

@@ -1,4 +1,4 @@
-threshold: 90.6
+threshold: 92.2
 require_exact_threshold: false
 rules:
   ApiTag::Presence:
@@ -21,7 +21,8 @@ rules:
     exclude: []
   Summary::Presence:
     enabled: true
-    exclude: []
+    exclude:
+      - Magicka::Element#initialize
   Summary::Length:
     enabled: true
     exclude: []

data/lib/magicka.rb

@@ -13,5 +13,6 @@ module Magicka
   autoload :VERSION,       'magicka/version'
   autoload :Element,       'magicka/element'
   autoload :Input,         'magicka/input'
+  autoload :InputElement,  'magicka/input_element'
   autoload :MethodBuilder, 'magicka/method_builder'
 end

data/lib/magicka/element.rb

@@ -10,6 +10,12 @@ module Magicka
     skip_validation
 
     class << self
+      # @api public
+      # @!visibility public
+      #
+      # Add available options
+      #
+      # @return [Array<Sinclair::MethodDefinition>]
       alias with_attributes with_options
 
       include ClassMethods
@@ -62,5 +68,16 @@ module Magicka
         hash.merge!(attribute => send(attribute))
       end
     end
+
+    # @api public
+    # @private
+    #
+    # Returns template file location
+    #
+    # @return [String]
+    def template
+      name.underscore
+          .gsub(%r{^.*/}, "#{template_folder}/")
+    end
   end
 end

data/lib/magicka/element/class_methods.rb

@@ -2,6 +2,8 @@
 
 module Magicka
   class Element < Sinclair::Options
+    # @api public
+    #
     # Class methods used for metaprograming of elements
     module ClassMethods
       # render template using the given prameters
@@ -20,11 +22,6 @@ module Magicka
         @locals ||= superclass.try(:locals)&.dup || Set.new([])
       end
 
-      private
-
-      # @api public
-      # @!visibility public
-      #
       # Sets template for element type
       #
       # @return [Array<Sinclair::MethodDefinition>]
@@ -34,6 +31,17 @@ module Magicka
           .add_template(template)
       end
 
+      # Sets template folder for element type
+      #
+      # @return [Array<Sinclair::MethodDefinition>]
+      def template_folder(folder)
+        MethodBuilder
+          .new(self)
+          .add_template_folder(folder)
+      end
+
+      private
+
       # @api public
       # @!visibility public
       #

data/lib/magicka/input.rb

@@ -2,46 +2,7 @@
 
 module Magicka
   # Input element representing an HTML +<input/>+
-  class Input < Element
-    with_attribute_locals :field, :placeholder, :label
-    with_attributes :model
-    with_locals :ng_errors, :ng_model
-
-    template 'templates/forms/input'
-
-    private
-
-    # @api private
-    # @private
-    #
-    # Label to be shon near the input
-    #
-    # when no label is provided, the name of
-    # the field is used
-    #
-    # @return [String]
-    def label
-      @label ||= field.to_s.capitalize.gsub(/_/, ' ')
-    end
-
-    # @api private
-    # @private
-    #
-    # ng model to be represented with the input
-    #
-    # @return [String]
-    def ng_model
-      [model, field].join('.')
-    end
-
-    # @api private
-    # @private
-    #
-    # ng errors to be exposed with the input
-    #
-    # @return [String]
-    def ng_errors
-      [model, :errors, field].join('.')
-    end
+  class Input < InputElement
+    with_attribute_locals :placeholder
   end
 end

data/lib/magicka/input_element.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Magicka
+  # @api public
+  #
+  # Basic class for elements for forms
+  class InputElement < Element
+    with_attribute_locals :field, :label
+    with_attributes :model
+    with_locals :ng_errors, :ng_model
+
+    private
+
+    # @api private
+    # @private
+    #
+    # Label to be shon near the input
+    #
+    # when no label is provided, the name of
+    # the field is used
+    #
+    # @return [String]
+    def label
+      @label ||= field.to_s.capitalize.gsub(/_/, ' ')
+    end
+
+    # @api private
+    # @private
+    #
+    # ng model to be represented with the input
+    #
+    # @return [String]
+    def ng_model
+      [model, field].join('.')
+    end
+
+    # @api private
+    # @private
+    #
+    # ng errors to be exposed with the input
+    #
+    # @return [String]
+    def ng_errors
+      [model, :errors, field].join('.')
+    end
+  end
+end

data/lib/magicka/method_builder.rb

@@ -19,5 +19,20 @@ module Magicka
 
       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

data/lib/magicka/version.rb

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

data/magicka.gemspec

@@ -19,17 +19,17 @@ Gem::Specification.new do |gem|
   gem.test_files            = gem.files.grep(%r{^(test|gem|features)/})
   gem.require_paths         = ['lib']
 
-  gem.add_runtime_dependency 'activesupport',       '~> 5.2.4.2'
-  gem.add_runtime_dependency 'sinclair',            '>= 1.6.6'
+  gem.add_runtime_dependency 'activesupport',       '~> 5.2.4.3'
+  gem.add_runtime_dependency 'sinclair',            '>= 1.6.7'
 
-  gem.add_development_dependency 'actionpack',               '5.2.4.2'
-  gem.add_development_dependency 'activerecord',             '5.2.4.2'
+  gem.add_development_dependency 'actionpack',               '5.2.4.3'
+  gem.add_development_dependency 'activerecord',             '5.2.4.3'
   gem.add_development_dependency 'bundler',                  '1.16.1'
   gem.add_development_dependency 'factory_bot',              '5.2.0'
   gem.add_development_dependency 'nokogiri',                 '1.10.9'
   gem.add_development_dependency 'pry',                      '0.12.2'
   gem.add_development_dependency 'pry-nav',                  '0.3.0'
-  gem.add_development_dependency 'rails',                    '5.2.4.2'
+  gem.add_development_dependency 'rails',                    '5.2.4.3'
   gem.add_development_dependency 'rails-controller-testing', '1.0.4'
   gem.add_development_dependency 'rake',                     '13.0.1'
   gem.add_development_dependency 'reek',                     '5.6.0'

data/spec/lib/magicka/element/class_methods_spec.rb

@@ -23,13 +23,13 @@ describe Magicka::Element::ClassMethods do
 
   describe '.template' do
     it do
-      expect { klass.send(:template, template) }
+      expect { klass.template(template) }
         .to add_method(:template)
         .to(klass)
     end
 
     context 'when method is build as requested' do
-      before { klass.send(:template, template) }
+      before { klass.template(template) }
 
       it 'returns the defined template when method is called' do
         expect(element.template).to eq(template)
@@ -37,9 +37,27 @@ describe Magicka::Element::ClassMethods do
     end
   end
 
+  describe '.template_folder' do
+    let(:folder) { 'templates/forms' }
+
+    it do
+      expect { klass.template_folder(folder) }
+        .to add_method(:template_folder)
+        .to(klass)
+    end
+
+    context 'when method is build as requested' do
+      before { klass.template_folder(folder) }
+
+      it 'returns the defined template when method is called' do
+        expect(element.template_folder).to eq(folder)
+      end
+    end
+  end
+
   describe '.render' do
     before do
-      klass.send(:template, template)
+      klass.template(template)
 
       allow(renderer)
         .to receive(:render)

data/spec/lib/magicka/element_spec.rb

@@ -11,26 +11,22 @@ describe Magicka::Element do
 
   let(:renderer) { instance_double('renderer') }
   let(:template) { 'templates/forms/element' }
+  let(:folder)   { 'templates/forms' }
   let(:locals)   { {} }
 
+  let(:method_builder)    { Sinclair.new(klass) }
+  let(:expected_template) { template }
+
   describe '#render' do
     before do
-      klass.send(:template, template)
-
       allow(renderer)
         .to receive(:render)
-        .with(partial: template, locals: locals)
-    end
-
-    it do
-      element.render
-
-      expect(renderer).to have_received(:render)
+        .with(partial: expected_template, locals: locals)
     end
 
-    context 'when initialized with extra params' do
-      subject(:element) do
-        klass.new(renderer: renderer, name: 'Name')
+    context 'when class has a defined template' do
+      before do
+        klass.template(template)
       end
 
       it do
@@ -38,17 +34,46 @@ describe Magicka::Element do
 
         expect(renderer).to have_received(:render)
       end
-    end
 
-    context 'when class have locals defined' do
-      subject(:element) do
-        klass.new(renderer: renderer, name: 'Name')
+      context 'when initialized with extra params' do
+        subject(:element) do
+          klass.new(renderer: renderer, name: 'Name')
+        end
+
+        it do
+          element.render
+
+          expect(renderer).to have_received(:render)
+        end
       end
 
-      let(:locals) { { name: 'Name' } }
+      context 'when class have locals defined' do
+        subject(:element) do
+          klass.new(renderer: renderer, name: 'Name')
+        end
+
+        let(:locals) { { name: 'Name' } }
+
+        before do
+          klass.send(:with_attribute_locals, :name)
+        end
+
+        it do
+          element.render
+
+          expect(renderer).to have_received(:render)
+        end
+      end
+    end
+
+    context 'when class has only folder defined' do
+      let(:expected_template) { 'templates/forms/input' }
 
       before do
-        klass.send(:with_attribute_locals, :name)
+        klass.template_folder(folder)
+
+        method_builder.add_method(:name) { 'Magicka::Input' }
+        method_builder.build
       end
 
       it do

data/spec/lib/magicka/input_element_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Magicka::InputElement do
+  let(:renderer) { instance_double('renderer') }
+  let(:template) { 'templates/forms/input' }
+
+  let(:model)       { :my_model }
+  let(:field)       { :field }
+  let(:label)       { 'Label' }
+
+  let(:locals) do
+    {
+      field: field,
+      label: label,
+      ng_errors: 'my_model.errors.field',
+      ng_model: 'my_model.field'
+    }
+  end
+
+  before do
+    described_class.template(template)
+  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

data/spec/lib/magicka/method_builder_spec.rb

@@ -25,4 +25,22 @@ describe Magicka::MethodBuilder do
       end
     end
   end
+
+  describe '#add_template_folder' do
+    let(:folder) { 'path_to_template_folder' }
+
+    it do
+      expect { builder.add_template_folder(folder) }
+        .to add_method(:template_folder)
+        .to(klass)
+    end
+
+    context 'when method is build as requested' do
+      before { builder.add_template_folder(folder) }
+
+      it 'returns the defined template folder when method is called' do
+        expect(instance.template_folder).to eq(folder)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magicka
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-24 00:00:00.000000000 Z
+date: 2020-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.4.2
+        version: 5.2.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.4.2
+        version: 5.2.4.3
 - !ruby/object:Gem::Dependency
   name: sinclair
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.6
+        version: 1.6.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.6
+        version: 1.6.7
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.4.2
+        version: 5.2.4.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.4.2
+        version: 5.2.4.3
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.4.2
+        version: 5.2.4.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.4.2
+        version: 5.2.4.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.4.2
+        version: 5.2.4.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.4.2
+        version: 5.2.4.3
 - !ruby/object:Gem::Dependency
   name: rails-controller-testing
   requirement: !ruby/object:Gem::Requirement
@@ -400,6 +400,7 @@ files:
 - lib/magicka/element.rb
 - lib/magicka/element/class_methods.rb
 - lib/magicka/input.rb
+- lib/magicka/input_element.rb
 - lib/magicka/method_builder.rb
 - lib/magicka/version.rb
 - magicka.gemspec
@@ -467,6 +468,7 @@ files:
 - spec/integration/yard/.keep
 - spec/lib/magicka/element/class_methods_spec.rb
 - spec/lib/magicka/element_spec.rb
+- spec/lib/magicka/input_element_spec.rb
 - spec/lib/magicka/input_spec.rb
 - spec/lib/magicka/method_builder_spec.rb
 - spec/spec_helper.rb