tmpl 1.0.0.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e400aa903cf908cf5c9e5d3dfcf7aecd6b227ef0
+  data.tar.gz: 97ce01944e438719735c4c4f394cb5515ef6c428
+SHA512:
+  metadata.gz: 7fa0c337b093afce2a9e09c24a8c8e57006f4be9a9c549ba02cfe66c35cddd858c65da1a7ecc6d441828b337557c3cab0b7505181be130b02c9b7a7f641d3345
+  data.tar.gz: 7b7224201984273e89618911763748bca20eddbd4c65f06182d5f68a987e3e11142ba7dad4ebd172463d7794f8c2c269d7b40aa2e424b65ee75739207733b70c

data/.autotest

@@ -0,0 +1,25 @@
+# -*- ruby -*-
+
+require "autotest/restart"
+
+# Autotest.add_hook :initialize do |at|
+#   at.testlib = "minitest/unit"
+#
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception "vendor"
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2014-02-14
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,12 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/tmpl.rb
+lib/tmpl/action_view_extension.rb
+lib/tmpl/engine.rb
+lib/tmpl/railtie.rb
+test/test_helper.rb
+test/test_tmpl.rb
+vendor/assets/javascripts/tmpl.js

data/README.txt

@@ -0,0 +1,130 @@
+= tmpl
+
+* https://github.com/nearapogee/tmpl
+* https://github.com/nearapogee/tmpl-example-app
+
+== DESCRIPTION:
+
+An agnostic approach to handle dynamic forms in rails.
+
+== FEATURES/PROBLEMS:
+
+* Simple: Build a template, multiply that template.
+* Minimal view duplication.
+* Works with deeply nested forms.
+* Built minimal and light.
+* Low coupling.
+* No magic.
+
+== SYNOPSIS:
+
+(abbreviated deeply nested example)
+
+# app/views/book/_form.html.erb
+<%= form_for(@book) do |f| %>
+  <div class="field">
+    <%= f.label :name %><br>
+    <%= f.text_field :name %>
+  </div>
+
+  <% tmpl_build :chapter, key: 'chapters_attributes' do %>
+    <%= f.fields_for :chapters, Chapter.new do |chapter_fields| %>
+      <%= render 'chapter', chapter_fields: chapter_fields, index: 0 %>
+    <% end %>
+  <% end %>
+
+  <%= tmpl_add_link "Add Chapter", :chapter, container: '.tmpl-container-chapter' %>
+
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>
+
+<%= tmpl :chapter %>
+<%= tmpl :heading %>
+
+# app/views/book/_chapter.html.erb
+<div class="tmpl">
+  <div class="field">
+    <%= chapter_fields.label :title %><br>
+    <%= chapter_fields.text_field :title %>
+  </div>
+  <%= chapter_fields.hidden_field :_destroy %>
+
+  <div class="tmpl-container-heading-<%= index %>">
+    <%= chapter_fields.fields_for :headings do |heading_fields| %>
+      <%= render 'heading', heading_fields: heading_fields %>
+    <% end %>
+  </div>
+
+  <% tmpl_build :heading, key: 'headings_attributes' do %>
+    <%= chapter_fields.fields_for :headings, Heading.new do |heading_fields| %>
+      <%= render 'heading', heading_fields: heading_fields %>
+    <% end %>
+  <% end %>
+
+  <%= tmpl_add_link 'Add Heading', :heading, container: ".tmpl-container-heading-#{index}" %>
+  <%= tmpl_remove_link 'Remove Chapter' %>
+</div>
+
+# app/views/book/_heading.html.erb
+<div class="tmpl">
+  <div class="field">
+    <%= heading_fields.label :text %><br>
+    <%= heading_fields.text_field :text %>
+  </div>
+  <%= heading_fields.hidden_field :_destroy %>
+
+  <%= tmpl_remove_link 'Remove Heading' %>
+</div>
+
+
+== REQUIREMENTS:
+
+* rails
+* jquery-rails
+
+== INSTALL:
+
+* Add to Gemfile:
+  gem 'tmpl'
+
+* Run:
+  bundle
+
+* Add to application.js  manifest:
+  //= require tmpl
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2014 Matthew C. Smith
+
+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/Rakefile

@@ -0,0 +1,21 @@
+# -*- ruby -*-
+
+require "rubygems"
+require "hoe"
+
+Hoe.plugin :minitest
+Hoe.plugin :git
+Hoe.plugin :isolate
+
+Hoe.spec "tmpl" do
+  developer("Matt Smith", "matt@nearapogee.com")
+
+  dependency('rails', '> 1.0.0')
+  dependency('hoe-git', '~> 1.6.0', :dev)
+  dependency('isolate', '~> 3.2.4', :dev)
+  dependency('minitest', '~> 4.7.5', :dev)
+
+  license "MIT"
+end
+
+# vim: syntax=ruby

data/lib/tmpl.rb

@@ -0,0 +1,5 @@
+module Tmpl
+  VERSION = "1.0.0.pre1"
+end
+
+Dir.glob(File.dirname(__FILE__) + '/tmpl/*.rb') { |file| require file }

data/lib/tmpl/action_view_extension.rb

@@ -0,0 +1,53 @@
+module Tmpl
+  module ActionViewExtension
+
+    # Add key option for deeply nested models.
+    #
+    def tmpl_build(tmpl, options={}, &block)
+      return if content_for?(:"#{tmpl}_tmpl").present?
+      if options.has_key? :key
+        options.merge!(:"data-tmpl-key" => options.delete(:key))
+      end
+      options.merge!(id: "#{tmpl}_tmpl", style: "display: none;")
+      content_for :"#{tmpl}_tmpl" do
+        content_tag(:div, options) { block.call }
+      end
+    end
+
+    def tmpl(tmpl)
+      content_for :"#{tmpl}_tmpl"
+    end
+
+    # Add container option if you want the add link outside of the template.
+    #
+    def tmpl_add_link(*args)
+      options = args.extract_options!
+      body, tmpl = args[-2], args[-1]
+      if options.has_key? :container
+        options.merge!(:"data-tmpl-container" => options.delete(:container))
+      end
+      options[:class] = options[:class].to_s.split(' ').tap { |classes|
+        classes << 'tmpl-add'
+      }.join(' ')
+      options.merge!(:"data-tmpl" => tmpl)
+      if block_given?
+        link_to("javascript:void(0)", options) { yield }
+      else
+        link_to( body, "javascript:void(0)", options)
+      end
+    end
+
+    def tmpl_remove_link(*args)
+      options = args.extract_options!
+      body = args[-1]
+      options[:class] = options[:class].to_s.split(' ').tap { |classes|
+        classes << 'tmpl-remove'
+      }.join(' ')
+      if block_given?
+        link_to("javascript:void(0)", options) { yield }
+      else
+        link_to(body, "javascript:void(0)", options)
+      end
+    end
+  end
+end

data/lib/tmpl/engine.rb

@@ -0,0 +1,4 @@
+module Tmpl
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/tmpl/railtie.rb

@@ -0,0 +1,9 @@
+module Tmpl
+  class Railtie < ::Rails::Railtie
+    initializer 'tmpl.include' do
+      ActiveSupport.on_load(:action_view) do
+        ::ActionView::Base.send :include, Tmpl::ActionViewExtension
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require "minitest/autorun"
+require "rails"
+require "action_view"
+require "tmpl"
+
+class Tmpl::Application < Rails::Application
+  config.secret_key_base = "0000"
+end
+
+ActionView::TestCase::TestController.instance_eval do
+  helper Rails.application.routes.url_helpers
+end
+
+ActionView::TestCase::TestController.class_eval do
+  def _routes
+    Rails.application.routes
+  end
+end
+

data/test/test_tmpl.rb

@@ -0,0 +1,60 @@
+require "test_helper"
+
+class TestTmpl < ActionView::TestCase
+  include Tmpl::ActionViewExtension
+
+  def setup
+    @view_flow = ActionView::OutputFlow.new
+  end
+
+  def test_tmpl_add_link
+    link = tmpl_add_link("Add", :chapter)
+    assert_select HTML::Document.new(link.to_s).root,
+      'a[class=tmpl-add][data-tmpl=chapter][href="javascript:void(0)"]',
+      'Add'
+  end
+
+  def test_tmpl_add_link_with_container
+    link = tmpl_add_link("Add", :chapter, container: '.tmpl-ctn')
+    assert_select HTML::Document.new(link.to_s).root,
+      'a[class="tmpl-add"][data-tmpl-container=".tmpl-ctn"]'
+  end
+
+  def test_tmpl_add_link_with_class
+    link = tmpl_add_link("Add", :chapter, class: 'my-cls')
+    assert_select HTML::Document.new(link.to_s).root,
+      'a[class="my-cls tmpl-add"]'
+  end
+
+  def test_tmpl_remove_link
+    link = tmpl_remove_link("Remove")
+    assert_select HTML::Document.new(link.to_s).root,
+      'a[class=tmpl-remove][href="javascript:void(0)"]',
+      'Remove'
+  end
+
+  def test_tmpl_remove_link_with_class
+    link = tmpl_remove_link("Remove", class: 'my-cls')
+    assert_select HTML::Document.new(link.to_s).root,
+      'a[class="my-cls tmpl-remove"]'
+  end
+
+  def test_tmpl_build
+    tmpl_build(:chapter) do
+      content_tag(:span, 'Template Content')
+    end
+    template = tmpl(:chapter)
+    assert_select HTML::Document.new(template.to_s).root,
+      'div[id=chapter_tmpl][style="display: none;"]' do
+      assert_select 'span', 'Template Content'
+    end
+  end
+
+  def test_tmpl_build_with_key
+    tmpl_build(:chapter, key: 'my-key') {}
+    template = tmpl(:chapter)
+    assert_select HTML::Document.new(template.to_s).root,
+      'div[id=chapter_tmpl][data-tmpl-key=my-key]'
+  end
+
+end

data/vendor/assets/javascripts/tmpl.js

@@ -0,0 +1,132 @@
+$(document).ready(function() {
+
+  function TmplContainerNotDefinedError() {
+    this.name = "TmplContainerNotDefined Error";
+    this.message = "Tmpl could not locate a container.";
+  }
+  TmplContainerNotDefinedError.prototype = new Error();
+  TmplContainerNotDefinedError.prototype.constructor = TmplContainerNotDefinedError;
+
+  function TmplTmplNotFoundError() {
+    this.name = "TmplTmplNotFound Error";
+    this.message = "Tmpl could not find a .tmpl element.";
+  }
+  TmplTmplNotFoundError.prototype = new Error();
+  TmplTmplNotFoundError.prototype.constructor = TmplTmplNotFoundError;
+
+  function TmplKeyNotFoundError(key) {
+    this.name = "TmplContainerNotFound Error";
+    this.message = 'Tmpl could not find a key matching: \'' + key + '\'';
+  }
+  TmplKeyNotFoundError.prototype = new Error();
+  TmplKeyNotFoundError.prototype.constructor = TmplKeyNotFoundError;
+
+  $(document).on('click', 'form .tmpl-add', function() {
+    var $this       = $(this);                      // link clicked
+    var time        = new Date().getTime();         // current time
+    var template    = $this.data('tmpl');           // template name
+    var $template   = $('#' + template + '_tmpl');  // template
+    var $content    = $($template.html().trim());   // parsed template content
+
+    // $ container (to add elements to)
+    if ($this.data('tmpl-container') !== undefined) {
+      var $container = $($this.data('tmpl-container') + ':visible');  // from container option
+    } else {
+      var $container = $($this.parents('.tmpl-container')[0]);        // if link is within container
+    }
+    if ($container.length === 0) throw new TmplContainerNotDefinedError();
+
+    var key           = '\\w+_attributes';            // default key - RegExp escaping
+    if ($template.data('tmpl-key') !== undefined) {
+      key             = $template.data('tmpl-key'); // key from template option
+    }
+    var keyRegExp         = new RegExp('.*\\[' + key + '\\]\\[\\d*\\]');
+
+    // $ tmpl
+    var _match        = null;
+    var indexRegExp   = new RegExp('\\[(\\w+)\\]\\[(\\d+)\\]', 'g');
+    var stemIndexes   = {};
+    var indexes       = {};
+    var $tmpl         = $($container.parents('.tmpl')[0]).data('index', true);
+    var $templateTmpl = $template.find('.tmpl:first');
+    if ($tmpl.length === 0) {
+      $tmpl = $templateTmpl;
+      $tmpl.removeData('index');
+    }
+    if ($tmpl.length === 0) throw new TmplTmplNotFoundError();
+
+    var $context      = $($tmpl.find('input,select,textarea')[0]);  // context element
+    var context       = $context.prop('name');                      // context element name
+    if ($tmpl.data('index')) {
+      _match = null;
+      while((_match = indexRegExp.exec(context)) !== null) {
+        indexes[_match[1]] = _match;
+      }
+    }
+
+    var $templateContext  = $($templateTmpl.find('input,select,textarea')[0]);  // template context element
+    var templateContext   = $templateContext.prop('name');                      // template context element name
+    var keyMatch          = templateContext.match(keyRegExp);                   // match of key with index
+    if (keyMatch === null) throw new TmplKeyNotFoundError(key);
+    var stem              = keyMatch[0];
+
+    // find all stem indexes
+    _match = null;
+    while((_match = indexRegExp.exec(stem)) !== null) {
+      stemIndexes[_match[1]] = _match;
+    }
+
+    // replace all indexes with either value from indexes obj or time.
+    for (var _key in stemIndexes) {
+      var stemMatch     = stemIndexes[_key];
+      var indexMatch    = indexes[_key];
+      var index         = (indexMatch) ? indexMatch[2] : time;
+      var match         = '[' + stemMatch[1] + '][' + index + ']';
+      stem = stem.replace(stemMatch[0], match);
+    }
+
+    var $inputs     = $content.find('input[name],textarea[name],select[name]');
+    $inputs.each(function(idx, element){
+      var $element  = $(element);
+      var name      = $element.prop('name');
+      var tail      = name.match(new RegExp('\\[' + key + '\\]\\[\\d+\\](.*)'))[1];
+      name          = stem + tail;
+      var id        = name.replace(/]/g, '').replace(/\[/g, '_');
+      $element.prop('name', name);
+      $element.prop('id', id);
+      // TODO also replace label for
+    });
+
+    $content.find('[class^=tmpl-container-]').each(function(idx, element){
+      var $element  = $(element);
+      $.each($element.prop('class').split(' '), function(idx, cls) {
+        var match = cls.match(new RegExp('^tmpl-container-(.*)-\\d+$'));
+        if (match !== null) {
+          $element.removeClass(cls);
+          $element.addClass('tmpl-container-' + match[1] + '-' + time);
+        }
+      });
+    });
+    $content.find('a.tmpl-add[data-tmpl-container^=".tmpl-container-"]').each(function(idx, element){
+      var $element  = $(element);
+      dataContainer = $element.data('tmpl-container');
+      var match = dataContainer.match(new RegExp('^\.tmpl-container-(.*)-\\d+$'));
+      if (match !== null) {
+        var newDataContainer = '.tmpl-container-' + match[1] + '-' + time;
+        $element.attr('data-tmpl-container', newDataContainer);
+        $element.data('tmpl-container', newDataContainer);
+      }
+    });
+
+    $container.append($content);
+  });
+
+  $(document).on('click', 'form .tmpl-remove', function() {
+    var $this = $(this);
+    var $tmpl = $($this.parents('.tmpl')[0]);
+    var $destroy = $($tmpl.find('input[type=hidden][name$="[_destroy]"]')[0]);
+    if ($destroy.length > 0) $destroy.val('1').change();
+    $tmpl.hide();
+  });
+
+});

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: tmpl
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre1
+platform: ruby
+authors:
+- Matt Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe-git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: isolate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.4
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: An agnostic approach to handle dynamic forms in rails.
+email:
+- matt@nearapogee.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.txt
+files:
+- ".autotest"
+- ".gemtest"
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/tmpl.rb
+- lib/tmpl/action_view_extension.rb
+- lib/tmpl/engine.rb
+- lib/tmpl/railtie.rb
+- test/test_helper.rb
+- test/test_tmpl.rb
+- vendor/assets/javascripts/tmpl.js
+homepage: https://github.com/nearapogee/tmpl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.txt
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: tmpl
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: An agnostic approach to handle dynamic forms in rails.
+test_files:
+- test/test_helper.rb
+- test/test_tmpl.rb