disable_section 0.0.6

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWI2NjBjNTY4MjEyZjZjNDA5MzFlN2E0MTk3MjlkYzYxNDgxNjQwMQ==
+  data.tar.gz: !binary |-
+    ZjdjMDVhZTE0ZTE4MjQ1ZmVkNTA2MzQyOTcxYjBhNThkMjc5YjcwMA==
+SHA512:
+  metadata.gz: !binary |-
+    ZmViM2VjYmJhOTc3NzAwYTY5ZmE1ZDBmOTE5NDkyMWQyZDdlYzdmZTVkNTc1
+    OWQxNDU2ZjAzYTk5YjVlYzQxNmNjZjk1Nzg1Yjg5OWM0NzJiMDk3ODFjNDUx
+    NTBmZjVlYWNlODhlZjliOTk1NjgzMDQ5OTkxYWM4ZjQwOWUyMTg=
+  data.tar.gz: !binary |-
+    N2FjOTgxYzc4MmIxYzYzMDczZGE2YjQ0NjQ2NDZjNWRkZDI5NjUwMzNjMDFj
+    N2RiN2JkNjMzOTY4ODg3YWFhMDBjMTc1M2YyOTk2ZTBlMWUzOGYyODYzM2Qx
+    ODNiNTFkMzJlMzVjNjcwNzBlZTZkYzUwZTQ5OTBkZmZiMmJiYTk=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in disable_section.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 yaniv preiss
+
+MIT License
+
+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,55 @@
+# Disable Section
+
+UI helper that disables an entire section with its inner html elements based on a given condition during render phase.
+For example, you have a form which can be edited only in "edit mode" but readonly in "view mode".
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'disable_section'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install disable_section
+
+## Usage
+
+  * In the ```application.js``` add
+
+     ```
+     //= require disable_section
+     ```
+
+  * In your html erb, use the ```disable_section``` helper, which receives a predicate and then a block to render.
+
+     If the predicate is true, then the default elements: a, input, select, textarea and button will be added the class 'disabled' (which you need to create CSS for), and also be added the 'disabled' attribute.
+
+     If the predicate is false, then the block will be rendered normally.
+
+    ```ruby
+      <%= disable_section view_mode? do %>  <!-- suppose view_mode? is your redicate -->
+        <%= f.email_field :email %>
+      <% end %>
+    ```
+
+  * If you want specific elements within the section to remain enabled, give them class ```keep-enabled```
+
+
+## Notes
+
+  * Note that it depends on jQuery, and works also on future elements (e.g. add new DOM elements via AJAX).
+
+  * It doesn't act as a toggler, that it, changing the predicate after the view has been rendered will have no effect.
+
+## TODO
+
+ Specs - add higher level and integration tests
+
+## License
+
+See MIT-LICENSE

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/disable_section.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'disable_section/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "disable_section"
+  spec.version       = DisableSection::VERSION
+  spec.authors       = ["yaniv preiss"]
+  spec.email         = ["yanivpr@gmail.com"]
+  spec.summary       = %q{UI helper that disables an entire section with its inner html elements based on a given condition}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 3.1"
+  spec.add_dependency "jquery-rails"
+
+  spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "bundler", "~> 1.4"
+  spec.add_development_dependency "rake"
+end

data/lib/assets/javascripts/disable_section.js

@@ -0,0 +1,23 @@
+/**
+ * Created by yanivpreiss on 4/15/14.
+ */
+
+var DisableSection = DisableSection || {};
+DisableSection.elements = 'a,input,select,textarea,button';
+
+DisableSection.disableSections = function () {
+    var $elementsToDisable = $(".disabled-section").find(DisableSection.elements).not(".keep-enabled");
+    $elementsToDisable.addClass("disabled");
+    $elementsToDisable.attr("disabled", "disabled");
+};
+
+DisableSection.subscribeDomChanges = function(){
+    document.body.addEventListener("DOMNodeInserted", function(){
+        DisableSection.disableSections();
+    }, false);
+};
+
+$(document).ready(function(){
+    DisableSection.subscribeDomChanges();
+    DisableSection.disableSections();
+});

data/lib/disable_section.rb

@@ -0,0 +1,5 @@
+require 'action_view'
+require "disable_section/version"
+require 'disable_section/engine'
+require 'disable_section/view_helpers'
+require 'disable_section/railtie' if defined? Rails

data/lib/disable_section/engine.rb

@@ -0,0 +1,8 @@
+require 'disable_section/version'
+
+module DisableSection
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/disable_section/railtie.rb

@@ -0,0 +1,9 @@
+require 'disable_section/view_helpers'
+
+module DisableSection
+  class Railtie < ::Rails::Railtie
+    initializer "disable_section.view_helpers" do |app|
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/disable_section/version.rb

@@ -0,0 +1,3 @@
+module DisableSection
+  VERSION = "0.0.6"
+end

data/lib/disable_section/view_helpers.rb

@@ -0,0 +1,14 @@
+module DisableSection
+  module ViewHelpers
+
+    DEFAULT_ELEMENTS = %w(a input select textarea button)
+
+    def disable_section(should_be_disabled = true, elements = DEFAULT_ELEMENTS, &block)
+      content_tag :div,
+                  { class: (should_be_disabled ? 'disabled-section' : ''),
+                  data: { elements: elements } },
+                  &block
+    end
+
+  end
+end

data/spec/lib/disable_section_helper_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'action_view/helpers'
+require 'disable_section/view_helpers'
+
+describe "DisableSection::ViewHelpers" do
+  include DisableSection::ViewHelpers
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::FormTagHelper
+  include ActionView::Context
+
+  context "disable_section" do
+
+    it "no block" do
+      expected = "<div>#{ERB::Util.html_escape({:class=>'disabled-section', :data=>{:elements=>['a', 'input', 'select', 'textarea', 'button']}})}</div>"
+      result = disable_section
+
+      result.should == expected
+    end
+
+    it "with no predicate and block containing div" do
+      expected = "<div class=\"disabled-section\" data-elements=\"#{ERB::Util.html_escape(['a','input','select','textarea','button']).gsub(' ', '')}\"><div>#{ERB::Util.html_escape({:id=>'inner'})}</div></div>"
+      result = disable_section do
+         content_tag :div, id: 'inner'
+      end
+
+      result.should == expected
+    end
+
+    it "with true predicate and block containing div" do
+      expected = "<div class=\"disabled-section\" data-elements=\"#{ERB::Util.html_escape(['a','input','select','textarea','button']).gsub(' ', '')}\"><div>#{ERB::Util.html_escape({:id=>'inner'})}</div></div>"
+      predicate = true
+      result = disable_section predicate do
+        content_tag :div, id: 'inner'
+      end
+
+      result.should == expected
+    end
+
+    it "with false predicare block containing input" do
+      expected = "<div class=\"\" data-elements=\"#{ERB::Util.html_escape(['a','input','select','textarea','button']).gsub(' ', '')}\"><input id=\"_:id___inner__\" name=\"#{ERB::Util.html_escape({:id=>'inner'})}\" type=\"text\" /></div>"
+      result = disable_section false do
+        text_field_tag id: 'inner'
+      end
+
+      result.should == expected
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'bundler/setup'
+require 'rails'
+require 'rspec'
+require 'disable_section'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end
+
+#ENV["RAILS_ENV"] = "test"
+#require 'bundler/setup'
+#Bundler.setup
+#
+#require 'rails/all'
+##require 'active_support'
+##require 'active_support/core_ext'
+#require 'rspec/rails'
+#require 'action_view'
+#require 'action_view/helpers'
+#require 'action_view/base'
+#require 'action_view'
+#require 'rspec/rails/view_rendering'
+#require 'rspec/core/formatters/html_formatter'
+#require 'rspec/rails/example/view_example_group'
+#require 'disable_section'
+#
+#RSpec.configure do |config|
+#  config.include DisableSection::DisableSectionHelper
+#end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: disable_section
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- yaniv preiss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: ''
+email:
+- yanivpr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- disable_section.gemspec
+- lib/assets/javascripts/disable_section.js
+- lib/disable_section.rb
+- lib/disable_section/engine.rb
+- lib/disable_section/railtie.rb
+- lib/disable_section/version.rb
+- lib/disable_section/view_helpers.rb
+- spec/lib/disable_section_helper_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: UI helper that disables an entire section with its inner html elements based
+  on a given condition
+test_files:
+- spec/lib/disable_section_helper_spec.rb
+- spec/spec_helper.rb