will_toggle 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 889d94bb1714f012c6941f1917779b84c9c33db2
+  data.tar.gz: 96353f998c76bbd5095b16e747b83de5ae68edb7
+SHA512:
+  metadata.gz: c1b4f35f454065c2ac36d5ee980e8321cf9e79e5fc54060ede87be8201d96f46925cc4acf6e864a9255786908b700c936fb01cbb6493c4c22e3f2f46665171f2
+  data.tar.gz: 545fb9f001f350d491c6b5c1fa57335992cc0d974e8a1aa9c633cde379e28012abf01b5159a6de2ee1f3504cdd987037503fab38935018e8a60179bcc59bcc65

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 will_toggle.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 johnotander
+
+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,70 @@
+# Will Toggle
+
+This gem is intended to clean up RoR views for jQuery toggling between hidden and visible elements.
+
+```ruby
+  <%= will_toggle label: 'Change Your Password', 
+                  partial: 'users/password_fields', 
+                  checked: false, 
+                  locals: { f: f } %>
+```
+
+Just like that, you now have a `check_box_tag` that will display the `password_fields` partial when checked, and hide it from view when unchecked.  This becomes very handy in complex forms when you want to hide certain fields from a user until they actively enable a feature.
+
+
+### How does it work?
+
+A `check_box_tag` is added with `label_tag 'Change Your Password'`.  The checkbox is wired in to the `onchange` event, which triggers a jQuery function to toggle a `will-toggle-wrapper` that encapsulates the partial.
+
+__Currently will\_toggle only supports a checkbox toggle, however, you can expect many more implementations to come.__
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'will_toggle'
+
+And then execute:
+
+    $ bundle install
+
+Or, install it yourself as:
+
+    $ gem install will_toggle
+
+
+## Usage
+
+A minimalist:
+```ruby
+  <%= will_toggle label: 'Change Your Password', partial: 'users/password_fields', locals: { f: f } %>
+```
+
+### Available options:
+
+  - `label`: the string you will use to describe the toggled div, i.e. show details.
+  - `checked`: true or false, defaults to false. Specifies whether the checkbox will be checked.
+  - `locals`: a hash of necessary variables for your partial.
+  - `clear_data`: true or false, defaults to false. If true, the toggle function will clear any values in any child `text_field` upon toggle. Especially useful for optional form fields.
+  
+All the bells and whistles:
+```ruby
+  <%= will_toggle label: 'Add Your Twitter Account', 
+                  partial: 'users/fields/twitter', 
+                  checked: false, 
+                  clear_data: true, 
+                  locals: { f: f } %>
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Acknowledgements
+
+This gem is inspired by [will\_paginate](https://www.github.com/mislav/will_paginate)

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/app/assets/javascripts/will_toggle.js.coffee

@@ -0,0 +1,4 @@
+window.willToggle =
+  toggleNext: (toggleID, clearData = false) ->
+    $(toggleID).slideToggle(200)
+    $(toggleID).find('input').val('') if clearData

data/lib/view_helpers.rb

@@ -0,0 +1,49 @@
+module WillToggle
+  module ViewHelpers
+    @@toggle_index ||= 0
+    
+    def will_toggle(options = {})
+      attribute = nil
+      @@toggle_index += 1
+      generate_html(attribute, options).html_safe
+    end
+  
+    def generate_html(attribute, options = {})
+      <<-HTML
+        <div class='will-toggle-wrapper'>
+          <div class='field check-box'>
+            #{ get_check_box(attribute, options) }
+          </div>
+          <div class='will-toggle-content' id="will-toggle-#{ @@toggle_index }" style="display: #{ visibility(options[:checked]) };">
+            #{ get_partial(options) }
+          </div>
+        </div>
+      HTML
+    end
+    
+    def visibility(checked = false)
+      checked ? :block : :none
+    end
+    
+    def get_check_box(attribute, options = {})
+      html = ''
+      if attribute
+        html << options[:form].check_box(attribute, onChange: js_call(options), class: 'check-box will-toggle-check-box')
+        html << options[:form].label(attribute, options[:label])
+      else
+        html << check_box_tag(nil, nil, options[:checked], onChange: js_call(options), class: 'check-box will-toggle-check-box')
+        html << label_tag(nil, options[:label], class: 'will-toggle-label')
+      end
+      html
+    end
+    
+    def get_partial(options = {})
+      render partial: options[:partial], 
+             locals: options[:locals]
+    end
+    
+    def js_call(options)
+      "willToggle.toggleNext('#will-toggle-#{ @@toggle_index }', #{ options[:clear_data] });"
+    end
+  end
+end

data/lib/will_toggle.rb

@@ -0,0 +1,11 @@
+require 'will_toggle/version'
+require 'will_toggle/engine'
+require 'view_helpers'
+
+module WillToggle
+  include ViewHelpers
+end
+
+defined?(Rails::Railtie) ?
+  require('will_toggle/railtie') :
+  raise('will_toggle requires Rails::Railtie')

data/lib/will_toggle/engine.rb

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

data/lib/will_toggle/railtie.rb

@@ -0,0 +1,11 @@
+require 'will_toggle'
+
+module WillToggle
+  class Railtie < Rails::Railtie
+    initializer "will_toggle" do |app|
+      ActionView::Base.send :include, WillToggle
+      require 'view_helpers'
+    end
+    require 'view_helpers'
+  end
+end

data/lib/will_toggle/version.rb

@@ -0,0 +1,3 @@
+module WillToggle
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require File.expand_path("../../config/environment", __FILE__)
+
+RSpec.configure do |config|
+  
+end

data/will_toggle.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/will_toggle/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "will_toggle"
+  gem.authors       = ["John Otander"]
+  gem.email         = ["johnotander@gmail.com"]
+  gem.description   = %q{This gem will toggle page content, based on the current state of a check button.}
+  gem.summary       = %q{Will toggle page content.}
+  gem.homepage      = "https://github.com/johnotander/will_toggle"
+  gem.version       = WillToggle::VERSION
+  gem.license       = "MIT"
+  
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency "rails"
+  gem.add_dependency "jquery-rails"
+  
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: will_toggle
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Otander
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: 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: 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: bundler
+  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: rspec
+  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: 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: This gem will toggle page content, based on the current state of a check
+  button.
+email:
+- johnotander@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/will_toggle.js.coffee
+- lib/view_helpers.rb
+- lib/will_toggle.rb
+- lib/will_toggle/engine.rb
+- lib/will_toggle/railtie.rb
+- lib/will_toggle/version.rb
+- spec/spec_helper.rb
+- will_toggle.gemspec
+homepage: https://github.com/johnotander/will_toggle
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Will toggle page content.
+test_files:
+- spec/spec_helper.rb