usefull_filter 0.0.4

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+0.0.1 (11 July 2012)
+- Starting projeect
+- test
+-test2

data/Gemfile

@@ -0,0 +1,19 @@
+#You can add lacal gems with
+# gem "my_gem", :path => "/home/www/gems/my_gem"
+#you must remove the path in production or if you change server and replace with:
+# git "git@10.2.252.240:my_gem.git"
+
+source "http://rubygems.org"
+
+gem "rails", "~>3.0.14"
+gem "meta_search"
+
+group :development, :test do
+  gem "ruby-debug"
+  gem "capybara", ">= 0.4.0"
+  gem "sqlite3"
+  gem "single_test"
+end
+
+gemspec
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,3 @@
+= UsefullFilter
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,32 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+  require "bundler/gem_tasks"
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'usefull_filter'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/app/helpers/usefull_filter_helper.rb

@@ -0,0 +1,72 @@
+#require "usefull_filter/filter_form_builder"
+#L'helper si occupa di wrappare la classe MetaSearch permettendo l'utilizzo di Filtri selezionabili dall'utente
+#
+#[documents_controller]
+# Vedi TableHelper
+#
+#[index.html.erb]
+# <%=filter_for_new @search, :url => magazzino_documents_path do |f| %>
+#   <%= f.text_field :data, :size => 10, :filters => ["equals", "less_than_or_equal_to", "greater_than_or_equal_to"] %>
+#   <%= f.text_field :DoCNr, :filters_type => :number %>
+#   <%= f.text_field :TbDoC, :filters_only => ["equals"] %>
+#   <%= f.text_field :BollaXENrDoC, filters_except => ["equals", "does_not_equal"] %>
+#   <%= f.text_field :DoCSit %>
+#   <%= f.submit %>
+# <% end %>
+module UsefullFilterHelper
+  #Contatta l'url passato ripassando i filtri attivi in @search
+  def filter_button_tag(name, url, method = :get)
+    if @search.kind_of?(MetaSearch::Builder)
+      form_tag(url, :method => method) do
+        @search.search_attributes.each  do |k,v|
+          if v.kind_of?(Array)
+            v.each{|vv| concat hidden_field_tag("search[#{k}][]", vv)} 
+          else
+            concat hidden_field_tag("search[#{k}]", v)
+          end
+        end
+        concat submit_tag(name)
+      end
+    end
+  end
+  
+  def filter_for_new(obj, *args, &proc)
+    filter_for(obj, *args, &proc)
+  end
+  
+  #Cerca una serie di filtri utilizzando MetaSearch di cui fa il wrapper
+  #obj è una istanza metashearch
+  def filter_for(obj, *args, &proc)
+    unless obj.blank?
+      options = args.extract_options!
+
+      options[:html] ||= {}
+      options[:html][:select] ||= {}
+      options[:html][:input] ||= {}
+      options[:html][:method] ||= :get
+      options[:html][:class] ||= "usefull_filter_container"
+      options[:html_1] = options.delete(:html)
+      options.merge!(:builder => UsefullFilter::FilterFormBuilder)
+     
+      remove_filter_label = I18n.t("remove_filter", :scope => "meta_search.buttons")
+      filter_title = I18n.t("filter_title", :scope => "meta_search.buttons")
+      
+      #Estraggo le options che mi interessano, perchè una volta passate al builder
+      #per qulache arcano motivo vengono alterate....
+      classe = options[:html_1].delete(:class)
+      url = options[:url]
+      #UserSession.log("FilterHelper#filter_for_new: options=#{options.inspect}")
+      content_tag(:div,
+        content_tag(:h3, filter_title) +
+        content_tag(:ul,
+          form_for(obj, *(args << options), &proc) +
+          form_tag(url_for(url), :method => :get) do
+            obj.search_attributes.each_key {|k| concat hidden_field_tag("search[#{k}]") } 
+            concat submit_tag(remove_filter_label, :class => "usefull_filter_push-2")
+          end ),
+      :class => classe)
+    end
+  end
+
+end
+

data/lib/generators/usefull_filter/install/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+module UsefullFilter
+  class InstallGenerator < Rails::Generators::Base
+    desc "Install generator for UsefullFilter gem"
+    source_root File.expand_path("../templates", __FILE__)
+    
+    #def copy_config
+    #  directory "config"
+    #end
+    
+    #def copy_public
+    #  directory "public"
+    #end
+    
+  end      
+end
+

data/lib/usefull_filter.rb

@@ -0,0 +1,7 @@
+module UsefullFilter
+end
+
+require "meta_search"
+require "usefull_filter/engine"
+require "usefull_filter/exceptions"
+#require "usefull_filter/filter_builder"

data/lib/usefull_filter/engine.rb

@@ -0,0 +1,20 @@
+module UsefullFilter
+  class Engine < Rails::Engine
+    
+    config.autoload_paths += Dir["#{config.root}/lib/**/"]
+
+    initializer 'usefull_filter.helper' do |app|
+      ActiveSupport.on_load(:action_controller) do
+        include UsefullFilterHelper
+      end
+      ActiveSupport.on_load(:action_view) do
+        include UsefullFilterHelper
+      end
+     
+    end
+  end
+  
+end
+
+#Add ere require to specific file or gem used
+

data/lib/usefull_filter/exceptions.rb

@@ -0,0 +1,17 @@
+#Localize messages in it.CustomError.MyError
+module UsefullFilter
+  class CustomError < StandardError
+    def initialize(*args)
+        @options = args.extract_options!
+        super
+    end
+      
+    def message
+      @options.merge!({:default => "Error : #{@options.inspect}"})
+      I18n.t("#{self.class.name.gsub(/::/,'.')}", @options )
+    end
+  end 
+
+  #class MyError < CustomError; end
+end
+

data/lib/usefull_filter/filter_form_builder.rb

@@ -0,0 +1,183 @@
+module UsefullFilter
+  class FilterFormBuilder < ActionView::Helpers::FormBuilder
+    
+    DEFAULT_TYPES=["equals", "does_not_equal", "in", "not_in"]
+    STRING_TYPES=["contains", "does_not_contain", "starts_with", "does_not_start_with", "ends_with", "does_not_end_with"]
+    NUMBER_TYPES=["greater_than", "greater_than_or_equal_to", "less_than", "less_than_or_equal_to"]
+    BOOLEAN_TYPES=["is_true", "is_false"]
+    OTHER_TYPES=["is_present", "is_blank"]
+  
+    #Ridefinisco il metodo per wrapparlo all'interno di una lista
+    #Accetta i seguenti parametri:
+    #*  :default_filter => "equals"
+    #*  :filters => ["equals", ....]
+    #
+    #Il nome sarà del tipo
+    #*  :ART
+    #*  "document.activity.id" (come per la tabelle)
+    def text_field(object_name, *args)
+        opt = define_args(args, object_name)
+        name = object_name.to_s.gsub(/\./, "_")
+        opt.merge!(@options[:html_1][:input])
+        #UserSession.log("FilterHelper#text_field:opt=#{opt.inspect}")
+        @template.content_tag(:li) do
+          @template.concat filter_list(name, opt[:default_filter], opt)
+          @template.concat " "
+          @template.concat super(default(name, opt[:default_filter]), opt)
+          ##UserSession.log("FilterHelper#text_field:object_name=#{object_name.inspect}")
+          #@template.concat attribute_type(object_name) == :Date ? @template.link_to(@template.image_tag('calendar16.png'), '#', :onclick => "show_calendar('search_data_prevista_equals')") : ''
+        end
+    end
+    
+    #Utilizza come filtro una combo, con i valori passati nell'array
+    def select(object_name, array, *args)
+      opt = define_args(args, object_name)
+      name = object_name.to_s.gsub(/\./, "_")
+      opt.merge!(@options[:html_1][:input])
+      @template.content_tag(:li) do
+        @template.concat filter_list(name, opt[:default_filter], opt)
+        @template.concat " "
+        #@template.concat select("search", default(name, opt[:default_filter]), array.collect {|p| [p,p]}, opt)
+        @template.concat super(default(name, opt[:default_filter]), array, opt)
+        ##UserSession.log("FilterHelper#text_field:object_name=#{object_name.inspect}")
+      end
+    end
+    
+    #Utilizza come filtro un elenco di valori rappresentati da una check_box
+    #che vengono gestiti come OR
+    #def checks(object_name, array, *args, &block)
+    #  super.to_s.html_safe
+    #end
+    
+    
+    #Genera una doppia text_box per gestire i filtri tra due
+    def between_field(object_name, *args)
+      opt = define_args(args, object_name)
+      name = object_name.to_s.gsub(/\./, "_")
+      @template.content_tag(:li,
+        multiparameter_field(name.to_s + "_between", 
+          {:field_type => :text_field}, {:field_type => :text_field}, :size => 5))
+    end
+    
+    def submit
+    	applay_filter_label = I18n.t(:applay_filter, :scope => "meta_search.buttons")
+      super(applay_filter_label, :class => "usefull_filter_push-1")
+    end
+      
+    private
+    
+    #Aggiusta il vettore dei parametri passati
+    #*  :default_filter => "equals"  filtro di default che deve essere presente in tutti i metodi
+    #*  :filters_only => ["equals", .. ] elenco di filtri da utilizzare, rimpiazza anche i dafault
+    #*  :filters_except => ["equals", .. ] elenco di filtri da escludere
+    #*  :filters => [..] elenco dei filtri richiesti, sovrascrive i default
+    #*  :filters_type => :string | :number | :boolean | :other da aggiungere a quelli gia presenti
+    def define_args(args, object_name)
+      opt = args.extract_options!
+      #Il filtro di default e _equals che deve essere presente su tutti i campi
+      opt[:filters] ||= DEFAULT_TYPES + type(object_name)
+      opt[:default_filter] ||= opt[:filters].include?("equals") ? "equals" : opt[:filters].first
+      opt[:filters_only] ||= []
+      opt[:filters_except] ||= []
+      case opt[:filters_type]
+        when :string
+          opt[:filters] |= STRING_TYPES
+        when :number
+          opt[:filters] |= NUMBER_TYPES
+        when :boolean
+          opt[:filters] |= BOOLEAN_TYPES
+        when :other
+          opt[:filters] |= OTHER_TYPES
+        end
+        
+      opt[:filters] -= opt[:filters_except]
+      opt[:filters] = opt[:filters_only] unless opt[:filters_only] .blank?
+      opt
+    end
+    
+    #Costruisce l'elenco dei filtri da utilizzare
+    #seleziona come selected il parametro trovato in params[] per garantire coerenza dopo il reload
+    def options_list(object_name, args, default_filter="equals")
+      filters = args[:filters].dup
+      filters.map! {|o| 
+        "<option value = '" + object_name.to_s + "_" +  o + "'" +
+        (default(object_name,default_filter) == object_name.to_s + "_" + o ? " selected = 'selected'" : "") +
+        " >" +
+        I18n.t(o, :scope =>"meta_search.predicates", :attribute => human(object_name)) +
+        "</option>"}
+      filters.join("").html_safe
+    end
+    
+    #Crea una lista dei filtri disponibili per il campo
+    def filter_list(object_name, default_filter, args)
+      list = options_list(object_name, args,default_filter)
+      ##UserSession.log("FilterHelper#filter_list:options=#{@options.inspect}")
+      #UserSession.log("FilterFormBuilder#filter_list list=#{list}")
+      #@template.select_tag(object_name, list.html_safe, :onchange => "document.getElementById('search_' + #{object_name.to_s}).name = 'search[' + this + ']'")
+      @options[:html_1][:select][:onchange] = "$(#{'search_' + default(object_name,default_filter)}).name = 'search[' + this.value + ']'; $(#{'search_' + default(object_name, default_filter)}).id = 'search_' + this.value "
+      @options[:html_1][:select][:id]       = object_name.to_s
+      @options[:html_1][:select][:class]    = "select_dati"
+      ##UserSession.log("FilterHelper#filter_list:options(before select_tag)=#{@options.inspect}")
+      @template.select_tag("", list, @options[:html_1][:select])
+    end
+    
+    #Restituisce l'elenco dei filtri associati al tipo di dati del DB
+    def type(object_name)
+      #case @object.base.columns_hash[object_name.to_s].type
+      case attribute_type(object_name)
+        when :String  then
+          STRING_TYPES
+        when :Bignum, :Fixnum, :Float, :Date, :Time, :Datetime then
+          NUMBER_TYPES
+        when :TrueClass, :FalseClass then
+          BOOLEAN_TYPES
+        when nil
+          []
+        else
+          OTHER_TYPES
+      end
+    end
+    
+    #Restituisce il tipo dellìattributo
+    #gestendo i multilivello document.activity.data_prevista => :Date
+    #==Nota:
+    #*  non testata con le relazioni polimorfiche...
+    #*  con metodi definit all'utente, restiuisce nil 
+    def attribute_type(attribute_name)
+      #UserSession.log("FilterFormBuilder#attribute_type attribute_name=#{attribute_name}, base=#{@object.base.name}")
+      #Aggiungo self. daventi in quanto i campi tipo ART vengono confusi per costanti se non specifico il contesto. SIGH!
+
+      attributes = attribute_name.to_s.split(".")
+      base = @object.base
+      method = attributes.pop
+      #UserSession.log("FilterFormBuilder#attribute_type(1) method=#{method}, base=#{base.name}, attributes=#{attributes.inspect}")
+      if attributes.length > 0
+        attributes.each do |association|
+          reflection = base.reflect_on_association(association.to_sym)
+          base = reflection.blank? ? nil : reflection.klass
+        end
+      end
+      ##UserSession.log("FilterFormBuilder#attribute_type(2) method=#{method}")
+      base.columns_hash[method.to_s].klass.name.to_sym unless base.blank? || base.columns_hash[method.to_s].blank?
+    end
+    
+    #Restituisce il nome del campo preso da ActiveRecord
+    def human(object_name)
+      ##UserSession.log("FilterFormBuilder#human classe=#{@object.class.name}")
+      @object.base.human_attribute_name(object_name.to_s)
+    end
+    
+    #Restituisce il valore di default prelevato da params[]
+    #altrimenti restituisce nome_equals
+    def default(nome, filter="equals")
+      out = ""
+      @object.search_attributes.each_key do |k|
+        out = k unless k.match(/^#{nome.to_s}/).nil?
+      end
+      out = out.blank? ? nome.to_s + "_" + filter : out
+      out
+    end
+    
+  end
+ 
+end

data/lib/usefull_filter/version.rb

@@ -0,0 +1,4 @@
+module UsefullFilter
+  VERSION = "0.0.4"
+end
+

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: usefull_filter
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
+platform: ruby
+authors: 
+- Andrea Bignozzi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 3
+        - 0
+        - 14
+        version: 3.0.14
+  type: :runtime
+  requirement: *id001
+  prerelease: false
+  name: rails
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  requirement: *id002
+  prerelease: false
+  name: meta_search
+description: Wraps meta_search with usefull helpers
+email: 
+- skylord73@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/helpers/usefull_filter_helper.rb
+- lib/usefull_filter/engine.rb
+- lib/usefull_filter/filter_form_builder.rb
+- lib/usefull_filter/exceptions.rb
+- lib/usefull_filter/version.rb
+- lib/generators/usefull_filter/install/install_generator.rb
+- lib/usefull_filter.rb
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.rdoc
+- CHANGELOG.md
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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.8.24
+signing_key: 
+specification_version: 3
+summary: Wraps meta_search with usefull helpers
+test_files: []
+