magicka 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6013fd94f8df1865e13bd0f17ddfd37b9605fb6cb72eebb14d7fa6a4761f48fd
-  data.tar.gz: 4ae9c53984064068371fc060aaf178a34f772940908619d4937fc4bf6345a345
+  metadata.gz: fb9d51d1218f32ac849193da117869a8bbc8bfa51f8cb2f8c7eb3c4845309200
+  data.tar.gz: e6728fa98edd29a39de7c53497e542496468006f7c5902f112b3860835f2579d
 SHA512:
-  metadata.gz: 2bdddadc15edd651be2484b29072e04b3b717d1cd45741996a3426a069bb5e6980fd42bf34d2d813b675d392d96f1aab278a87484f82488a7255bb4414ee350e
-  data.tar.gz: '0783b6e54e90f43e71cf6d361ee34b9ae3bb4179f87b48f96e1a47c47ae72a2e4e8fa92d2e0f5870b2649905208e1bfa3fc6efbca7e24e40b260efdc3f05c7cc'
+  metadata.gz: 07b9a25dd6fd4bb5d978a0d1a8f20e94320735b288ad469f31a2c31331f146f6b0f7c9ef54294d171e87732af3090e3093f7b04785a165ebf89d59f4e9ffb09a
+  data.tar.gz: 0da01e6080f9c53033dd44ff44f1fe37e442c27875f477d2c16005c3f17fe604a2206c3e10cf20d20b3a0732ca8ac4eb56226f3ac8294ed41604864173632e94

data/README.md

@@ -1,4 +1,4 @@
-Jace
+Magicka
 ====
 [![Code Climate](https://codeclimate.com/github/darthjee/magicka/badges/gpa.svg)](https://codeclimate.com/github/darthjee/magicka)
 [![Test Coverage](https://codeclimate.com/github/darthjee/magicka/badges/coverage.svg)](https://codeclimate.com/github/darthjee/magicka/coverage)
@@ -11,7 +11,7 @@ Jace
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/magicka/0.0.1](https://www.rubydoc.info/gems/magicka/0.0.1)
+[https://www.rubydoc.info/gems/magicka/0.1,0](https://www.rubydoc.info/gems/magicka/0.1.0)
 
 Installation
 ---------------

data/config/check_specs.yml

@@ -1,2 +1,3 @@
 ignore:
   - lib/magicka/version.rb
+  - lib/magicka.rb

data/config/yardstick.yml

@@ -1,4 +1,4 @@
-threshold: 100
+threshold: 90.6
 require_exact_threshold: false
 rules:
   ApiTag::Presence:

data/lib/magicka.rb

@@ -2,6 +2,16 @@
 
 # @api public
 # @author darthjee
-class Magicka
-  autoload :VERSION, 'magicka/version'
+
+require 'sinclair'
+
+# @api public
+# @author Darthjee
+#
+# module holding herlper to render inputs
+module Magicka
+  autoload :VERSION,       'magicka/version'
+  autoload :Element,       'magicka/element'
+  autoload :Input,         'magicka/input'
+  autoload :MethodBuilder, 'magicka/method_builder'
 end

data/lib/magicka/element.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Magicka
+  # @api public
+  #
+  # Base class for element rendering
+  class Element < Sinclair::Options
+    autoload :ClassMethods, 'magicka/element/class_methods'
+
+    skip_validation
+
+    class << self
+      alias with_attributes with_options
+
+      include ClassMethods
+    end
+
+    # @method with_attributes
+    # @api public
+    # @!visibility public
+    #
+    # Adds attribute
+    #
+    # This will affect initialization and add readers
+    #
+    # @return [Array]
+
+    # Render element HTML
+    def render
+      renderer.render partial: template, locals: locals
+    end
+
+    private
+
+    attr_reader :renderer
+    # @api private
+    # @private
+    # @method renderer
+    #
+    # Object responsible for rendering the HTML
+
+    # @api private
+    # @private
+    #
+    # @param (see .render)
+    def initialize(renderer:, **args)
+      @renderer = renderer
+      super(**args)
+    end
+
+    # @api private
+    # @private
+    #
+    # Returns hash of local variables
+    #
+    # Local variablees will be available when rendering
+    # the template
+    #
+    # @return [Hash]
+    def locals
+      self.class.locals.inject({}) do |hash, attribute|
+        hash.merge!(attribute => send(attribute))
+      end
+    end
+  end
+end

data/lib/magicka/element/class_methods.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Magicka
+  class Element < Sinclair::Options
+    # Class methods used for metaprograming of elements
+    module ClassMethods
+      # render template using the given prameters
+      #
+      # @param renderer [Object] object responsible for rendering
+      #   the HTML
+      # @param args [Hash] Extra options
+      def render(renderer:, **args)
+        new(renderer: renderer, **args).render
+      end
+
+      # list of attributes to be used when rendering
+      #
+      # @return [Set<Symbol>]
+      def locals
+        @locals ||= superclass.try(:locals)&.dup || Set.new([])
+      end
+
+      private
+
+      # @api public
+      # @!visibility public
+      #
+      # Sets template for element type
+      #
+      # @return [Array<Sinclair::MethodDefinition>]
+      def template(template)
+        MethodBuilder
+          .new(self)
+          .add_template(template)
+      end
+
+      # @api public
+      # @!visibility public
+      #
+      # Add an attribute to locals when rendereing
+      #
+      # the attribute will be a call to the a method
+      # with same name
+      #
+      # @return [Set<Symbol>]
+      def with_locals(*args)
+        locals.merge(args)
+      end
+
+      # @api public
+      # @!visibility public
+      #
+      # Adds attribute and locals
+      #
+      # @return [Array]
+      def with_attribute_locals(*args)
+        with_locals(*args)
+        with_attributes(*args)
+      end
+    end
+  end
+end

data/lib/magicka/input.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+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
+  end
+end

data/lib/magicka/method_builder.rb

@@ -0,0 +1,23 @@
+# 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
+  end
+end

data/lib/magicka/version.rb

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

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

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Magicka::Element::ClassMethods do
+  subject(:element) { klass.new(renderer: renderer) }
+
+  let(:klass) do
+    Class.new(Magicka::Element)
+  end
+
+  let(:renderer) { instance_double('renderer') }
+  let(:template) { 'templates/forms/element' }
+  let(:locals)   { {} }
+
+  describe '.with_attributes' do
+    it do
+      expect { klass.send(:with_attributes, :field) }
+        .to add_method(:field)
+        .to(klass)
+    end
+  end
+
+  describe '.template' do
+    it do
+      expect { klass.send(:template, template) }
+        .to add_method(:template)
+        .to(klass)
+    end
+
+    context 'when method is build as requested' do
+      before { klass.send(:template, template) }
+
+      it 'returns the defined template when method is called' do
+        expect(element.template).to eq(template)
+      end
+    end
+  end
+
+  describe '.render' do
+    before do
+      klass.send(:template, template)
+
+      allow(renderer)
+        .to receive(:render)
+        .with(partial: template, locals: locals)
+    end
+
+    it do
+      klass.render(renderer: renderer)
+
+      expect(renderer).to have_received(:render)
+    end
+
+    context 'when called with extra params' do
+      it do
+        klass.render(renderer: renderer, name: 'Name')
+
+        expect(renderer).to have_received(:render)
+      end
+    end
+  end
+
+  describe '.locals' do
+    it { expect(Magicka::Element.locals).to eq(Set.new([])) }
+
+    context 'when calling on a subclass' do
+      it { expect(klass.locals).to eq(Set.new([])) }
+    end
+
+    context 'when called on subclass' do
+      let(:subclass) { Class.new(klass) }
+
+      before { klass.send(:with_locals, :field, :model) }
+
+      it { expect(subclass.locals).to eq(Set.new(%i[field model])) }
+    end
+  end
+
+  describe 'with_locals' do
+    it do
+      expect { klass.send(:with_locals, :field, :model) }
+        .to change(klass, :locals)
+        .from([])
+        .to(%i[field model])
+    end
+
+    it do
+      expect { klass.send(:with_locals, :field, :model) }
+        .not_to change(Magicka::Element, :locals)
+    end
+
+    it do
+      expect { klass.send(:with_locals, :field) }
+        .not_to add_method(:field)
+        .to(klass)
+    end
+
+    context 'when called on subclass' do
+      let(:subclass) { Class.new(klass) }
+
+      before { klass.send(:with_locals, :field, :model) }
+
+      it do
+        expect { subclass.send(:with_locals, :error) }
+          .to change(subclass, :locals)
+          .from(%i[field model])
+          .to(%i[field model error])
+      end
+
+      it do
+        expect { subclass.send(:with_locals, :error) }
+          .not_to change(klass, :locals)
+      end
+    end
+  end
+
+  describe 'with_attribute_locals' do
+    it do
+      expect { klass.send(:with_attribute_locals, :field, :model) }
+        .to change(klass, :locals)
+        .from([])
+        .to(%i[field model])
+    end
+
+    it do
+      expect { klass.send(:with_attribute_locals, :field, :model) }
+        .not_to change(Magicka::Element, :locals)
+    end
+
+    it do
+      expect { klass.send(:with_attribute_locals, :field) }
+        .to add_method(:field)
+        .to(klass)
+    end
+
+    context 'when called on subclass' do
+      let(:subclass) { Class.new(klass) }
+
+      before { klass.send(:with_attribute_locals, :field, :model) }
+
+      it do
+        expect { subclass.send(:with_attribute_locals, :error) }
+          .to change(subclass, :locals)
+          .from(%i[field model])
+          .to(%i[field model error])
+      end
+
+      it do
+        expect { subclass.send(:with_attribute_locals, :error) }
+          .not_to change(klass, :locals)
+      end
+    end
+  end
+end

data/spec/lib/magicka/element_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Magicka::Element do
+  subject(:element) { klass.new(renderer: renderer) }
+
+  let(:klass) do
+    Class.new(described_class)
+  end
+
+  let(:renderer) { instance_double('renderer') }
+  let(:template) { 'templates/forms/element' }
+  let(:locals)   { {} }
+
+  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)
+    end
+
+    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
+
+    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
+end

data/spec/lib/magicka/input_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Magicka::Input do
+  let(:renderer) { instance_double('renderer') }
+  let(:template) { 'templates/forms/input' }
+
+  let(:model)       { :my_model }
+  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
+
+  describe '.render' do
+    let(:arguments) do
+      {
+        renderer: renderer,
+        field: field,
+        label: label,
+        placeholder: placeholder,
+        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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Magicka::MethodBuilder do
+  subject(:builder) { described_class.new(klass) }
+
+  let(:klass)    { Class.new }
+  let(:instance) { klass.new }
+
+  describe '#add_template' do
+    let(:template) { 'path_to_template' }
+
+    it do
+      expect { builder.add_template(template) }
+        .to add_method(:template)
+        .to(klass)
+    end
+
+    context 'when method is build as requested' do
+      before { builder.add_template(template) }
+
+      it 'returns the defined template when method is called' do
+        expect(instance.template).to eq(template)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,12 +2,10 @@
 
 require 'simplecov'
 
-SimpleCov.profiles.define 'gem' do
+SimpleCov.start do
   add_filter '/spec/'
 end
 
-SimpleCov.start 'gem'
-
 require 'magicka'
 require 'pry-nav'
 
@@ -20,6 +18,7 @@ require File.expand_path('spec/dummy/config/environment')
 require File.expand_path('spec/dummy/db/schema.rb')
 require 'rspec/rails'
 require 'active_support/railtie'
+require 'sinclair/matchers'
 
 support_files = File.expand_path('spec/support/**/*.rb')
 Dir[support_files].sort.each { |file| require file }
@@ -34,4 +33,5 @@ RSpec.configure do |config|
   config.filter_run_excluding :integration unless ENV['ALL']
 
   config.order = 'random'
+  config.include Sinclair::Matchers
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magicka
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - DarthJee
@@ -397,6 +397,10 @@ files:
 - config/yardstick.yml
 - docker-compose.yml
 - lib/magicka.rb
+- lib/magicka/element.rb
+- lib/magicka/element/class_methods.rb
+- lib/magicka/input.rb
+- lib/magicka/method_builder.rb
 - lib/magicka/version.rb
 - magicka.gemspec
 - magicka.jpg
@@ -461,7 +465,10 @@ files:
 - spec/dummy/storage/.keep
 - spec/integration/readme/.keep
 - spec/integration/yard/.keep
-- spec/lib/magicka_spec.rb
+- spec/lib/magicka/element/class_methods_spec.rb
+- spec/lib/magicka/element_spec.rb
+- spec/lib/magicka/input_spec.rb
+- spec/lib/magicka/method_builder_spec.rb
 - spec/spec_helper.rb
 - spec/support/models/.keep
 - spec/support/shared_examples/.keep

data/spec/lib/magicka_spec.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Magicka do
-  it 'does something' do
-  end
-end