filterable_table 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Bantik
+
+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.rdoc

@@ -0,0 +1,62 @@
+= filterable_table
+
+FilterableTable uses client-side JavaScript to hide or show table rows based on characters typed by a user. Simply type the characters to be used for filtering the table and press enter to focus the table; press escape to show all table rows. 
+
+This gem is currently in alpha mode; use at your own risk. It's been tested under Safari only; IE is not currently supported.
+
+== Installation
+
+* Install the gem:
+
+    gem install filterable_table
+    
+* Add the following to your application's Rakefile:
+
+    require 'filterable_table/tasks'
+    
+* Install the supporting code:
+
+    rake filterable_table:install
+
+* Add this line to your app/helpers/application_helper.rb file:
+
+    include FilterableTable::Helper
+
+== Usage
+
+Usage is simple. First, set the class name of each table row in your table to 'filterable'. Then insert the filter_table method just before where your table appears in the view.
+
+Example:
+
+  <%= filter_table -%>
+
+  <table>
+    <thead>
+      <tr>
+        <th>Name</th>
+        <th>URL</th>
+      </tr>
+    </thead>
+    <tbody>
+      <%- @foos.each do |foo| -%>
+        <tr class="filterable">
+          <td><%= foo.name -%></td>
+          <td><%= foo.url -%></td>
+        </tr>
+      <%- end -%>
+    </tbody>
+  </table>
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Corey Ehmke / SEO Logic. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "filterable_table"
+    gem.summary = %Q{Simple client-side JavaScript to filter a table as you type.}
+    gem.description = %Q{Simple client-side JavaScript to filter a table as you type.}
+    gem.email = "corey@seologic.com"
+    gem.homepage = "http://github.com/Bantik/filterable_table"
+    gem.authors = ["Bantik"]
+    #gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "filterable_table #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/filterable_table.gemspec

@@ -0,0 +1,49 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{filterable_table}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bantik"]
+  s.date = %q{2010-10-07}
+  s.description = %q{Simple client-side JavaScript to filter a table as you type.}
+  s.email = %q{corey@seologic.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "filterable_table.gemspec",
+     "init.rb",
+     "javascripts/filterable_table.js",
+     "lib/filterable_table.rb",
+     "lib/filterable_table/helper.rb",
+     "lib/filterable_table/tasks.rb"
+  ]
+  s.homepage = %q{http://github.com/Bantik/filterable_table}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Simple client-side JavaScript to filter a table as you type.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/init.rb

@@ -0,0 +1,3 @@
+require 'filterable_table'
+
+ActionView::Base.send :include, FilterableTable::Helper

data/javascripts/filterable_table.js

@@ -0,0 +1,37 @@
+var filter = ""
+  
+function showAll() { $$('.filterable').invoke('show'); }
+
+function hideAll() { $$('.filterable').invoke('hide'); }
+
+function findAll(str) {
+  showAll();
+  elems = [];
+  while (node = window.find(str, false, false)) {
+    if (elem = window.getSelection().getRangeAt(0).startContainer.parentNode.up('.filterable')) {
+      elems.push(elem);
+    }
+  }
+  while (node = window.find(str, false, true)) {
+    if (elem = window.getSelection().getRangeAt(0).startContainer.parentNode.up('.filterable')) {
+      elems.push(elem);
+    }
+  }
+  if (elems.first()) {
+    hideAll();
+    elems.invoke('show');
+    filter = "";
+  }
+}
+
+Event.observe(window, 'keydown', function (e){
+  if (e.keyCode == 13) {
+    findAll(filter);
+    filter = "";
+  } else if (e.keyCode == 27) {
+    showAll();    
+    filter = "";
+  } else if ((e.keyCode > 64) && (e.keyCode < 91)) {
+    filter += String.fromCharCode(e.keyCode);
+  }
+});

data/lib/filterable_table.rb

@@ -0,0 +1,2 @@
+module FilterableTable
+end

data/lib/filterable_table/helper.rb

@@ -0,0 +1,51 @@
+module FilterableTable
+
+  unloadable
+
+  module Helper
+    unloadable
+  
+    # To make this work, set the class name of each table row in your table to 'filterable'.
+    # Then insert the filter_table method just before your table appears in the layout.
+    #
+    # Example:
+    #
+    #   <%= filter_table -%>
+    #
+    #   <table>
+    #     <thead>
+    #       <tr>
+    #         <th>Name</th>
+    #         <th>URL</th>
+    #       </tr>
+    #     </thead>
+    #     <tbody>
+    #       <%- @foos.each do |foo| -%>
+    #         <tr class="filterable">
+    #           <td><%= foo.name -%></td>
+    #           <td><%= foo.url -%></td>
+    #         </tr>
+    #       <%- end -%>
+    #     </tbody>
+    #   </table>
+    #
+    def filter_table(args = {:show_instructions => true})
+      insert = ""
+      insert << %{
+        <p class="instructions">To filter this table, start typing your search term and press 'enter'. To show all table rows, press 'escape'.</p>
+      } if args[:show_instructions]
+      insert << %{
+        <script type="text/javascript">
+          var head = document.getElementsByTagName('head')[0];
+          var script = document.createElement('script');
+          script.type = 'text/javascript';
+          script.src = '/javascripts/filterable_table.js';
+          head.appendChild(script);
+        </script>
+      }
+      insert
+    end
+    
+  end
+  
+end

data/lib/filterable_table/tasks.rb

@@ -0,0 +1,13 @@
+# require 'filterable_table/tasks' to add tasks to the host application.
+
+namespace :filterable_table do
+
+  desc "Install filterable_table"
+  task :install do
+    dir = Gem.searcher.find('filterable_table').full_gem_path 
+    system "rsync -ruv #{dir}/javascripts public/"
+    puts
+    puts "FilterableTable installation complete."
+  end
+  
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: filterable_table
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bantik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-07 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Simple client-side JavaScript to filter a table as you type.
+email: corey@seologic.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- filterable_table.gemspec
+- init.rb
+- javascripts/filterable_table.js
+- lib/filterable_table.rb
+- lib/filterable_table/helper.rb
+- lib/filterable_table/tasks.rb
+has_rdoc: true
+homepage: http://github.com/Bantik/filterable_table
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple client-side JavaScript to filter a table as you type.
+test_files: []
+