dom_for 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b16dcf148d4790560acde632f078b54ccff7d74a
-  data.tar.gz: c33232372a7e525d096994734ec30f60fc4c3862
+  metadata.gz: b8fc0fad1bfddcb6a68a0801745603b5d4a4aed9
+  data.tar.gz: 6c713b8e9135fb37737a3c5dd56da9dc05b5b09a
 SHA512:
-  metadata.gz: bdc1f2f5634fb9f225921d9f65f839bbc104c5d508881a6771bae76c54a2bd4c69a199bc0ca55880b499335fc585efb0fa0d827993d3af795ce74828565e5574
-  data.tar.gz: a6fc8f2bb298596d1346137e5b13fdc82b09a1aae5e469cc7d114dd2097444ca8743065326f01dbac659c5850086c5434fe78563a5710e190d601f2f5bba08e2
+  metadata.gz: 22b9ee7cb04d7c2c19328533812d64bfe486d7a687333cb43c6e52e422e15c58f445877a374b164b8b12b4d384704001cddd8ca2917b6e2ccbf271d2c26ac2b1
+  data.tar.gz: 001723acf36b81251b7ac16a9c266fc2c31863f449ad06a10131f1c8ec80839d9d2949cc1bdd0b843323ae1aee0d0c5cb18d4d7b95beb720f7f291f0d368dc48

data/.rubocop.yml

@@ -0,0 +1,40 @@
+AllCops:
+  # Cop names are not displayed in offense messages by default. Change behavior
+  # by overriding DisplayCopNames, or by giving the -D/--display-cop-names
+  # option.
+  DisplayCopNames: true
+  # Style guide URLs are not displayed in offense messages by default. Change
+  # behavior by overriding DisplayStyleGuide, or by giving the
+  # -S/--display-style-guide option.
+  DisplayStyleGuide: true
+  Exclude:
+    - 'bin/**/*'
+    - 'spec/**/*'
+    - 'vendor/**/*'
+
+# Missing top-level class documentation comment
+Style/Documentation:
+  Enabled: false
+
+# Line is too long
+# https://github.com/bbatsov/ruby-style-guide#80-character-limits
+Metrics/LineLength:
+  Max: 180 # 80
+
+# Assignment Branch Condition size for perform is too high
+# http://c2.com/cgi/wiki?AbcMetric
+Metrics/AbcSize:
+  Enabled: false
+
+# Method has too many lines
+# https://github.com/bbatsov/ruby-style-guide#short-methods
+Metrics/MethodLength:
+  Max: 25 # 10
+
+# Cyclomatic complexity for dom_for_model is too high
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+# Perceived complexity for dom_for_model is too high
+Metrics/PerceivedComplexity:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.1.0 (24/11/2015)
+
+### Features
+
+* Ability to passing the name of tag as an argument
+
 ## 1.0.2 (26/03/2014)
 
 ### Enhancements

data/Gemfile

@@ -16,4 +16,4 @@ gem 'jquery-rails'
 # To use debugger
 # gem 'debugger'
 
-gem 'coveralls', require: false
+gem 'coveralls', require: false

data/README.md

@@ -24,11 +24,13 @@ Or install it yourself as:
 
 ## Usage
 
+By default the helper `dom_for` creates tag `div`. But it can override, passing an additional argument `tag`, for example: `dom _for User, tag: :span`:
+
 ```erb
 <%# /app/views/users/index.html.erb %>
 <%= dom_for User, attribute_1: 'value_1', attribute_2: 'value_2', attribute_3: 'value_3' do %>
   <% @users.each do |user| %>
-    <%= dom_for user, admin: user.admin, blocked: user.blocked do %>
+    <%= dom_for user, tag: :p, admin: user.admin, blocked: user.blocked do %>
       <%= content_tag(:span, user.name) %>
     <% end %>
   <% end %>
@@ -37,10 +39,10 @@ Or install it yourself as:
 
 ```html
 <div id="users" class="users" data-action="index" data-attribute-1="value_1" data-attribute-2="value_2" data-attribute-3="value_3">
-  <div id="user_1" class="user" data-admin="true" data-blocked="false" data-object-id="1">
+  <p id="user_1" class="user" data-admin="true" data-blocked="false" data-object-id="1">
     <span>Mikhail</span>
   </div>
-  <div id="user_2" class="user" data-admin="false" data-blocked="false" data-object-id="2">
+  <p id="user_2" class="user" data-admin="false" data-blocked="false" data-object-id="2">
     <span>Yulia</span>
   </div>
 </div>
@@ -95,11 +97,11 @@ The third argument, the helper `dom_for`, takes a block of code that will be wra
 
 ```erb
 <%# /app/views/users/index.html.erb %>
-<%= dom_for User %>
+<%= dom_for User, tag: :span %>
 ```
 
 ```html
-<div id="users" class="users" data-action="index" />
+<span id="users" class="users" data-action="index" />
 ```
 
 When defined instance variable with class name, the helper `dom_for` creates the additional html-attributes for this object:

data/dom_for.gemspec

@@ -1,5 +1,5 @@
 # coding: utf-8
-$:.push File.expand_path('../lib', __FILE__)
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 
 # Maintain your gem's version:
 require 'dom_for/version'
@@ -28,4 +28,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec-rails'
   s.add_development_dependency 'yard', '~> 0.8.7'
   s.add_development_dependency 'redcarpet', '~> 3.0' # Markdown implementation (for yard)
-end
+  s.add_development_dependency 'rubocop'
+end

data/lib/dom_for/model.rb

@@ -26,32 +26,33 @@ module DomFor
     # Creates a div tag with the attributes for the model of ActiveRecord
     #
     # @example Without the block:
-    #   dom_for_model(User) #=> <div class="users" id="users" />
+    #   dom_for(User) #=> <div class="users" id="users" />
     #
     # @example When there is a request:
-    #   dom_for_model(User) #=> <div class="users" data-action="show" id="users" />
+    #   dom_for(User) #=> <div class="users" data-action="show" id="users" />
     #
     # @example For the new user:
-    #   dom_for_model(User) #=> <div class="user new_user" data-action="new" id="new_user" />
+    #   dom_for(User) #=> <div class="user new_user" data-action="new" id="new_user" />
     #
     # @example For the saved record (if exists @user):
-    #   dom_for_model(User) #=> <div class="user show_user" data-action="show" data-object-id="1" data-object="users" id="user_1" />
+    #   dom_for(User) #=> <div class="user show_user" data-action="show" data-object-id="1" data-object="users" id="user_1" />
     #
     # @example With the additional attributes:
-    #   dom_for_model(User, admin: true) #=> <div class="user show_user" data-action="show" data-admin="true" data-object-id="1" data-object="users" id="user_1" />
+    #   dom_for(User, admin: true) #=> <div class="user show_user" data-action="show" data-admin="true" data-object-id="1" data-object="users" id="user_1" />
     #
     # @example With the block:
-    #   dom_for_model(User, admin: true) do
+    #   dom_for(User, admin: true) do
     #     tag(:span)
     #   end #=> <div class="user show_user" data-action="show" data-admin="true" data-object-id="1" data-object="users" id="user_1"><span /></div>
     #
-    # @param [Class] klass Model of ActiveRecord::Base
-    # @param [Hash] attrs Additional attributes for the record
-    # @param [Proc] block Block for a div tag
+    # @param klass [Class] Model of ActiveRecord::Base
+    # @param tag [Symbol] HTML tag name
+    # @param attrs [Hash] Additional attributes for the record
+    # @param block [Proc] Block for a div tag
     #
     # @return [String] Sanitized HTML string
     #
-    def dom_for_model(klass, attrs={}, &block)
+    def _dom_for_model(klass, tag, attrs = {}, &block)
       object_classes  = []
       class_name      = klass.to_s.underscore
       request_action  = request.path_parameters[:action]
@@ -60,6 +61,7 @@ module DomFor
 
       object = instance_variable_get("@#{class_name}")
 
+      # TODO: Need refactoring
       object_id = if object
                     if object.persisted?
                       attrs = attrs.merge(object_id: object.id, object: class_name.pluralize)
@@ -76,13 +78,14 @@ module DomFor
                   end
 
       if block_given?
-        content_tag(:div, id: object_id, class: object_classes.join(' '), data: attrs, &block)
+        content_tag(tag, id: object_id, class: object_classes.join(' '), data: attrs, &block)
       else
-        tag(:div, id: object_id, class: object_classes.join(' '), data: attrs)
+        tag(tag, id: object_id, class: object_classes.join(' '), data: attrs)
       end
-
     rescue
-      content_tag(:div, &block)
+      content_tag(tag, &block)
     end
+
+    private :_dom_for_model
   end
-end
+end

data/lib/dom_for/record.rb

@@ -11,39 +11,41 @@ module DomFor
     # Creates a div tag with the attributes for the instance of ActiveRecord
     #
     # @example For the new record:
-    #   dom_for_record(User.new) #=> <div class="user" id="new_user" />
+    #   dom_for(User.new) #=> <div class="user" id="new_user" />
     #
     # @example For the saved record:
-    #   dom_for_record(@user) #=> <div class="user" data-object-id="1" id="user_1" />
+    #   dom_for(@user) #=> <div class="user" data-object-id="1" id="user_1" />
     #
     # @example With the additional attributes:
-    #   dom_for_record(@user, admin: true) #=> <div class="user" data-admin="true" data-object-id="1" id="user_1" />
+    #   dom_for(@user, admin: true) #=> <div class="user" data-admin="true" data-object-id="1" id="user_1" />
     #
     # @example With the block:
-    #   dom_for_record(@user, admin: true) do
+    #   dom_for(@user, admin: true) do
     #     tag(:span)
     #   end #=> <div class="user" data-admin="true" data-object-id="1" id="user_1"><span /></div>
     #
-    # @param [ActiveRecord::Base] record Instance of ActiveRecord::Base
-    # @param [Hash] attrs Additional attributes for the record
-    # @param [Proc] block Block for a div tag
+    # @param record [ActiveRecord::Base] Instance of ActiveRecord::Base
+    # @param tag [Symbol] HTML tag name
+    # @param attrs [Hash] Additional attributes for the record
+    # @param block [Proc] Block for a div tag
     #
     # @return [String] Sanitized HTML string
     #
-    def dom_for_record(record, attrs={}, &block)
+    def _dom_for_record(record, tag, attrs = {}, &block)
       object_id     = dom_id(record)
       object_class  = dom_class(record.class)
 
       attrs = attrs.merge(object_id: record.id) if record.persisted?
 
       if block_given?
-        content_tag(:div, id: object_id, class: object_class, data: attrs, &block)
+        content_tag(tag, id: object_id, class: object_class, data: attrs, &block)
       else
-        tag(:div, id: object_id, class: object_class, data: attrs)
+        tag(tag, id: object_id, class: object_class, data: attrs)
       end
-
     rescue
-      content_tag(:div, &block)
+      content_tag(tag, &block)
     end
+
+    private :_dom_for_record
   end
-end
+end

data/lib/dom_for/version.rb

@@ -1,3 +1,3 @@
 module DomFor
-  VERSION = '1.0.3'
+  VERSION = '1.1.0'
 end

data/lib/dom_for.rb

@@ -1,8 +1,12 @@
-require 'active_support/dependencies/autoload'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/string/inflections'
 
+require_relative 'dom_for/model'
+require_relative 'dom_for/record'
+
 module DomFor
+  include Model
+  include Record
   #
   # dom_for Project do
   #
@@ -15,31 +19,23 @@ module DomFor
   #   dom_for Comment do
   #     dom_for comment, private: true
   #
-  extend ActiveSupport::Autoload
-
-  autoload :Model
-  autoload :Record
-
-  include Model
-  include Record
-
-  #
-  # Creates a div tag with the attributes for the model or record of ActiveRecord
+  # Creates a html tag with the attributes for the model or record of ActiveRecord
   #
-  # @param [ActiveRecord::Base, Class] object Model or record of ActiveRecord
-  # @param [Hash] attrs Additional attributes for the record
-  # @param [Proc] block Block for a div tag
+  # @param object [ActiveRecord::Base, Class] Model or record of ActiveRecord
+  # @param attrs [Hash] Additional attributes for the record
+  # @param block [Proc] Block for a div tag
   #
   # @return [String] Sanitized HTML string
   #
-  def dom_for(object, attrs={}, &block)
+  def dom_for(object, attrs = {}, &block)
+    tag = attrs.delete(:tag) || :div
+
     if object.instance_of? Class
-      dom_for_model(object, attrs, &block)
+      _dom_for_model(object, tag, attrs, &block)
     else
-      dom_for_record(object, attrs, &block)
+      _dom_for_record(object, tag, attrs, &block)
     end
   end
-
 end
 
-require_relative 'dom_for/railtie' if defined? Rails
+require_relative 'dom_for/railtie' if defined? ::Rails

data/spec/helpers/dom_for_spec.rb

@@ -1,21 +1,93 @@
 require 'rails_helper'
 
 describe DomFor do
-
   it 'includes in ActiveView::Base' do
     expect(ActionView::Base.ancestors).to include(DomFor)
-    expect(ActionView::Base.ancestors).to include(DomFor::Model)
-    expect(ActionView::Base.ancestors).to include(DomFor::Record)
   end
 
   context '#dom_for' do
-    it 'invokes #dom_for_model' do
-      expect(helper.dom_for(User)).to eq '<div id="users" class="users" />'
+    it 'returns span tag' do
+      expect(helper.dom_for(User, tag: :span)).to eq '<span id="users" class="users" />'
+    end
+
+    context 'with model' do
+      it 'returns div without nested tags' do
+        expect(helper.dom_for(User)).to eq '<div id="users" class="users" />'
+      end
+
+      it 'returns div with data-action attribute' do
+        expect(helper.request).to receive(:path_parameters).and_return({ action: 'show' })
+
+        expect(helper.dom_for(User)).to eq '<div id="users" class="users" data-action="show" />'
+      end
+
+      it 'returns div for the new user' do
+        @user = User.new(name: 'test')
+        expect(helper.request).to receive(:path_parameters).and_return({ action: 'new' })
+
+        expect(helper.dom_for(User)).to eq '<div id="new_user" class="user new_user" data-action="new" />'
+      end
+
+      it 'returns div for the new user without request' do
+        @user = User.new(name: 'test')
+
+        expect(helper.dom_for(User)).to eq '<div id="new_user" class="user" />'
+      end
+
+      it 'returns div for the saved user' do
+        @user = User.create(name: 'test')
+        expect(helper.request).to receive(:path_parameters).and_return({ action: 'show' })
+
+        expect(
+          helper.dom_for(User)
+        ).to eq '<div id="user_1" class="user show_user" data-action="show" data-object-id="1" data-object="users" />'
+      end
+
+      it 'returns div with the additional data-attributes' do
+        @user = User.create(name: 'test')
+        expect(helper.request).to receive(:path_parameters).and_return({ action: 'show' })
+
+        expect(
+          helper.dom_for(User, admin: true)
+        ).to eq '<div id="user_1" class="user show_user" data-admin="true" data-action="show" data-object-id="1" data-object="users" />'
+      end
+
+      it 'returns div with nested tags' do
+        @user = User.create(name: 'test')
+        expect(helper.request).to receive(:path_parameters).and_return({ action: 'show' })
+
+        expect(
+          helper.dom_for(User, admin: true) { helper.tag(:span) }
+        ).to eq '<div id="user_1" class="user show_user" data-admin="true" data-action="show" data-object-id="1" data-object="users"><span /></div>'
+      end
     end
 
-    it 'invokes #dom_for_record' do
-      expect(helper.dom_for(User.new)).to eq '<div id="new_user" class="user" />'
+    context 'with record' do
+      it 'returns div for the new user' do
+        expect(helper.dom_for(User.new)).to eq '<div id="new_user" class="user" />'
+      end
+
+      it 'returns div without nested tags' do
+        user = User.create(name: 'test')
+
+        expect(helper.dom_for(user)).to eq '<div id="user_1" class="user" data-object-id="1" />'
+      end
+
+      it 'returns div with nested tags' do
+        user = User.create(name: 'test')
+
+        expect(
+          helper.dom_for(user) { helper.tag(:span) }
+        ).to eq '<div id="user_1" class="user" data-object-id="1"><span /></div>'
+      end
+
+      it 'returns div with the additional data-attributes' do
+        user = User.create(name: 'test')
+
+        expect(
+            helper.dom_for(user, admin: true) { helper.tag(:span) }
+        ).to eq '<div id="user_1" class="user" data-admin="true" data-object-id="1"><span /></div>'
+      end
     end
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dom_for
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Mikhail Grachev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2015-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Helper for easy creation of HTML wrapper ActiveRecord objects.
 email:
 - work@mgrachev.com
@@ -88,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
 - ".yardopts"
@@ -153,8 +168,6 @@ files:
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
-- spec/helpers/dom_for_model_spec.rb
-- spec/helpers/dom_for_record_spec.rb
 - spec/helpers/dom_for_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
@@ -178,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: Helper for creating HTML wrappers ActiveRecord objects.
@@ -234,8 +247,6 @@ test_files:
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
-- spec/helpers/dom_for_model_spec.rb
-- spec/helpers/dom_for_record_spec.rb
 - spec/helpers/dom_for_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb

data/spec/helpers/dom_for_model_spec.rb

@@ -1,57 +0,0 @@
-require 'rails_helper'
-
-describe DomFor::Model do
-
-  context '#dom_for_model' do
-    it 'returns empty div' do
-      expect(helper.dom_for_model(User.new)).to eq '<div></div>'
-    end
-
-    it 'returns div without nested tags' do
-      expect(helper.dom_for_model(User)).to eq '<div id="users" class="users" />'
-    end
-
-    it 'returns div with data-action attribute' do
-      expect(helper.request).to receive(:path_parameters).and_return({ action: 'show' })
-
-      expect(helper.dom_for_model(User)).to eq '<div id="users" class="users" data-action="show" />'
-    end
-
-    it 'returns div for the new user' do
-      @user = User.new(name: 'test')
-      expect(helper.request).to receive(:path_parameters).and_return({ action: 'new' })
-
-      expect(helper.dom_for_model(User)).to eq '<div id="new_user" class="user new_user" data-action="new" />'
-    end
-
-    it 'returns div for the new user without request' do
-      @user = User.new(name: 'test')
-
-      expect(helper.dom_for_model(User)).to eq '<div id="new_user" class="user" />'
-    end
-
-    it 'returns div for the saved user' do
-      @user = User.create(name: 'test')
-      expect(helper.request).to receive(:path_parameters).and_return({ action: 'show' })
-
-      expect(helper.dom_for_model(User)).to eq '<div id="user_1" class="user show_user" data-action="show" data-object-id="1" data-object="users" />'
-    end
-
-    it 'returns div with the additional data-attributes' do
-      @user = User.create(name: 'test')
-      expect(helper.request).to receive(:path_parameters).and_return({ action: 'show' })
-
-      expect(helper.dom_for_model(User, admin: true)).to eq '<div id="user_1" class="user show_user" data-admin="true" data-action="show" data-object-id="1" data-object="users" />'
-    end
-
-    it 'returns div with nested tags' do
-      @user = User.create(name: 'test')
-      expect(helper.request).to receive(:path_parameters).and_return({ action: 'show' })
-
-      expect(
-        helper.dom_for_model(User, admin: true) { helper.tag(:span) }
-      ).to eq '<div id="user_1" class="user show_user" data-admin="true" data-action="show" data-object-id="1" data-object="users"><span /></div>'
-    end
-  end
-
-end

data/spec/helpers/dom_for_record_spec.rb

@@ -1,37 +0,0 @@
-require 'rails_helper'
-
-describe DomFor::Record do
-
-  context '#dom_for_record' do
-    it 'returns empty div' do
-      expect(helper.dom_for_record(User)).to eq '<div></div>'
-    end
-
-    it 'returns div for the new user' do
-      expect(helper.dom_for_record(User.new)).to eq '<div id="new_user" class="user" />'
-    end
-
-    it 'returns div without nested tags' do
-      user = User.create(name: 'test')
-
-      expect(helper.dom_for_record(user)).to eq '<div id="user_1" class="user" data-object-id="1" />'
-    end
-
-    it 'returns div with nested tags' do
-      user = User.create(name: 'test')
-
-      expect(
-        helper.dom_for_record(user) { helper.tag(:span) }
-      ).to eq '<div id="user_1" class="user" data-object-id="1"><span /></div>'
-    end
-
-    it 'returns div with the additional data-attributes' do
-      user = User.create(name: 'test')
-
-      expect(
-          helper.dom_for_record(user, admin: true) { helper.tag(:span) }
-      ).to eq '<div id="user_1" class="user" data-admin="true" data-object-id="1"><span /></div>'
-    end
-  end
-
-end