dom_for 1.0.0

data/.gitignore

@@ -0,0 +1,25 @@
+.coveralls.yml
+.idea/
+vendor/
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+log/*.log
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm: 1.9.3
+before_script:
+  - cd spec/dummy
+  - RAILS_ENV=test bundle exec rake db:migrate
+  - cd ../

data/.yardopts

@@ -0,0 +1,7 @@
+--markup markdown
+--markup-provider redcarpet
+--charset utf-8
+--readme README.md
+-
+README.md
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0 (24/03/2014)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,21 @@
+source 'https://rubygems.org'
+
+ruby '1.9.3'
+
+# Declare your gem's dependencies in dom_for.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+gem 'jquery-rails'
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'
+
+gem 'coveralls', require: false

data/Gemfile.lock

@@ -0,0 +1,133 @@
+PATH
+  remote: .
+  specs:
+    dom_for (1.0.0)
+      rails (~> 3.2.17)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.17)
+      actionpack (= 3.2.17)
+      mail (~> 2.5.4)
+    actionpack (3.2.17)
+      activemodel (= 3.2.17)
+      activesupport (= 3.2.17)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.17)
+      activesupport (= 3.2.17)
+      builder (~> 3.0.0)
+    activerecord (3.2.17)
+      activemodel (= 3.2.17)
+      activesupport (= 3.2.17)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.17)
+      activemodel (= 3.2.17)
+      activesupport (= 3.2.17)
+    activesupport (3.2.17)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    arel (3.0.3)
+    builder (3.0.4)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    diff-lcs (1.2.5)
+    docile (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.9)
+    journey (1.0.4)
+    jquery-rails (3.1.0)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    multi_json (1.9.0)
+    polyglot (0.3.4)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.17)
+      actionmailer (= 3.2.17)
+      actionpack (= 3.2.17)
+      activerecord (= 3.2.17)
+      activeresource (= 3.2.17)
+      activesupport (= 3.2.17)
+      bundler (~> 1.0)
+      railties (= 3.2.17)
+    railties (3.2.17)
+      actionpack (= 3.2.17)
+      activesupport (= 3.2.17)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.1.1)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    redcarpet (3.1.1)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    rspec-rails (2.14.1)
+      actionpack (>= 3.0)
+      activemodel (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.9)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.18.1)
+    tilt (1.4.1)
+    tins (1.0.0)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.39)
+    yard (0.8.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls
+  dom_for!
+  jquery-rails
+  redcarpet (~> 3.0)
+  rspec-rails
+  sqlite3
+  yard (~> 0.8.7)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Mikhail Grachev
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,133 @@
+# DomFor
+
+Helper for creating HTML wrappers ActiveRecord objects
+
+[![Build Status](https://travis-ci.org/mgrachev/dom_for.png?branch=master)](https://travis-ci.org/mgrachev/dom_for)
+[![Coverage Status](https://coveralls.io/repos/mgrachev/dom_for/badge.png?branch=master)](https://coveralls.io/r/mgrachev/dom_for?branch=master)
+[![Dependency Status](https://gemnasium.com/mgrachev/dom_for.svg)](https://gemnasium.com/mgrachev/dom_for)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dom_for'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dom_for
+
+## Usage
+
+```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 %>
+      <%= content_tag(:span, user.name) %>
+    <% end %>
+  <% end %>
+<% end %>
+```
+
+```html
+<div class="users" data-action="index" data-attribute-1="value_1" data-attribute-2="value_2" data-attribute-3="value_3" id="users">
+  <div class="user" data-admin="true" data-blocked="false" data-object-id="1" id="user_1">
+    <span>Mikhail</span>
+  </div>
+  <div class="user" data-admin="false" data-blocked="false" data-object-id="2" id="user_2">
+    <span>Yulia</span>
+  </div>
+</div>
+```
+
+The first argument can be used as a model ActiveRecord:
+
+```erb
+<%= dom_for User do %>
+  <%= tag(:span) %>
+<% end %>
+```
+
+```html
+<div class="users" data-action="index" id="users" />
+  <span />
+</div>
+```
+
+And record ActiveRecord:
+
+```erb
+<%= dom_for @user do %>
+  <%= tag(:span) %>
+<% end %>
+```
+
+```html
+<div class="user" data-action="show" data-object-id="1" id="user_1" />
+  <span />
+</div>
+```
+
+The second argument passed to additional html-attributes (is optional):
+
+```erb
+<%= dom_for User, attribute_1: 'value_1', attribute_2: 'value_2' do %>
+  <%= tag(:span) %>
+<% end %>
+```
+
+```html
+<div class="users" data-action="index" data-attribute-1="value_1" data-attribute-2="value_2" id="users" />
+  <span />
+</div>
+```
+
+The third argument, the helper `dom_for`, takes a block of code that will be wrapped in the tag `<div>` (is optional):
+
+```erb
+<%= dom_for User %>
+```
+
+```html
+<div class="users" data-action="index" id="users" />
+```
+
+When defined instance variable with class name, the helper `dom_for` creates the additional html-attributes for this object:
+
+```erb
+<% @user = User.last %>
+<%= dom_for User do %>
+  <%= tag(:span) %>
+<% end %>
+```
+
+```html
+<div class="user" data-action="show" data-object-id="1" data-object="users" id="user_1" >
+  <span />
+</div>
+```
+
+For each request, the helper `dom_for` creates additional attribute `data-action`, which will be equal to the method of the controller handling the request:
+
+```erb
+<%= dom_for User do %>
+  <%= tag(:span) %>
+<% end %>
+```
+
+```html
+<div class="users" data-action="index" id="users">
+  <span />
+</div>
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rspec/core/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+YARD::Rake::YardocTask.new
+
+Bundler::GemHelper.install_tasks

data/dom_for.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+# Maintain your gem's version:
+require 'dom_for/version'
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = 'dom_for'
+  s.version     = DomFor::VERSION
+  s.authors     = ['Mikhail Grachev']
+  s.email       = ['work@mgrachev.com']
+  s.homepage    = 'https://github.com/mgrachev/dom_for'
+  s.summary     = 'Helper for creating HTML wrappers ActiveRecord objects.'
+  s.description = 'Helper for easy creation of HTML wrapper ActiveRecord objects.'
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_dependency 'rails', '~> 3.2.17'
+
+  s.add_development_dependency 'sqlite3'
+  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

data/lib/dom_for/model.rb

@@ -0,0 +1,88 @@
+module DomFor
+  #
+  # Name of classes
+  # Pages:
+  #   index - users
+  #   new   - user new_user
+  #   edit  - user edit_user
+  #   show  - user show_user
+  #
+  # ID name
+  # Pages:
+  #   index - users
+  #   new   - new_user
+  #   edit  - user_1
+  #   show  - user_1
+  #
+  # Data-attributes
+  # Pages:
+  #   index - data-action = index
+  #   new   - data-action = new
+  #   edit  - data-action = edit, data-object-id = 1
+  #   show  - data-action = show, data-object-id = 1
+  #
+  module Model
+    #
+    # 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" />
+    #
+    # @example When there is a request:
+    #   dom_for_model(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" />
+    #
+    # @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" />
+    #
+    # @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" />
+    #
+    # @example With the block:
+    #   dom_for_model(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
+    #
+    # @return [String] Sanitized HTML string
+    #
+    def dom_for_model(klass, attrs={}, &block)
+      object_classes  = []
+      class_name      = klass.to_s.underscore
+      request_action  = request.path_parameters[:action]
+
+      attrs.merge!(action: request_action) if request_action.present?
+
+      object = instance_variable_get("@#{class_name}")
+
+      object_id = if object
+                    if object.persisted?
+                      attrs = attrs.merge(object_id: object.id, object: class_name.pluralize)
+                    end
+
+                    object_classes << dom_class(klass)
+                    object_classes << dom_class(klass, request_action) if request_action.present?
+
+                    dom_id(object)
+                  else
+                    object_classes << class_name.pluralize
+
+                    class_name.pluralize
+                  end
+
+      if block_given?
+        content_tag(:div, id: object_id, class: object_classes.join(' '), data: attrs, &block)
+      else
+        tag(:div, id: object_id, class: object_classes.join(' '), data: attrs)
+      end
+
+    rescue
+      content_tag(:div, &block)
+    end
+  end
+end

data/lib/dom_for/record.rb

@@ -0,0 +1,49 @@
+module DomFor
+  #
+  # Class name: user
+  #
+  # ID name: user_1
+  #
+  # Data-attributes: data-object-id = 1
+  #
+  module Record
+    #
+    # 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" />
+    #
+    # @example For the saved record:
+    #   dom_for_record(@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" />
+    #
+    # @example With the block:
+    #   dom_for_record(@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
+    #
+    # @return [String] Sanitized HTML string
+    #
+    def dom_for_record(record, 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)
+      else
+        tag(:div, id: object_id, class: object_class, data: attrs)
+      end
+
+    rescue
+      content_tag(:div, &block)
+    end
+  end
+end

data/lib/dom_for/version.rb

@@ -0,0 +1,3 @@
+module DomFor
+  VERSION = '1.0.0'
+end

data/lib/dom_for.rb

@@ -0,0 +1,43 @@
+require 'active_support/dependencies/autoload'
+
+module DomFor
+  #
+  # dom_for Project do
+  #
+  #   dom_for Task do
+  #     dom_for task, attribute: 'yes'
+  #
+  #   dom_for User do
+  #     dom_for user, admin: false
+  #
+  #   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
+  #
+  # @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
+  #
+  # @return [String] Sanitized HTML string
+  #
+  def dom_for(object, attrs={}, &block)
+    if object.instance_of? Class
+      dom_for_model(object, attrs, &block)
+    else
+      dom_for_record(object, attrs, &block)
+    end
+  end
+
+end
+
+ActionView::Helpers.send(:include, DomFor)

data/spec/dummy/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress