dynamic_query 0.1.0 → 0.1.1

data/README.md

@@ -1,8 +1,45 @@
-= dynamic_query
+# dynamic_query
 
-Description goes here.
+dynamic_query is a dynamic generated query gui for ActiveRecord.
 
-== Contributing to dynamic_query
+Installation:
+
+``` ruby
+## Gemfile for Rails 3
+gem 'dynamic_query'
+
+## rails generator
+rails g dynamic_query
+
+## you may skip this step unless you want to customize your own helper
+rails g dynamic_query:helper
+```
+
+## Basic usage of dynamic_query
+
+``` ruby
+## controller of Rails 3
+dq = dynamic_query(:list, :entry) # list models you wish to be queried. e.g. List => :list, AbcDef => :abc_def
+@panel = dq.panel(params[:query])
+@lists = List.includes(:entries).where(dq.statement(params[:query]))
+
+## render query panel in the view:
+<%= dynamic_query @panel %>
+```
+
+## Advanced usage of dynamic_query
+
+``` ruby
+# columns with name 'id' or name ended with '_id' are hided by default
+# :reveal_keys => true reveals those columns in the query panel
+dq = dynamic_query(:list, :entry, :reveal_keys => true)
+
+# a white list or a black list can be defined by following options
+dq = dynamic_query(:list, :entry, :accept => { :list => [:name], :entry => [:title, :priority] }, :reject => { :entry => [:title] })
+# only lists.name and entries.priority can be seen on the query panel because the white list gets higher precedence than the black list
+```
+
+# Contributing to dynamic_query
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
@@ -12,7 +49,7 @@ Description goes here.
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+# Copyright
 
 Copyright (c) 2012 Wei-Ming Wu. See LICENSE.txt for
 further details.

data/app/helpers/dynamic_query.erb

@@ -0,0 +1,39 @@
+<%= form_tag(request.url, opt.merge(:style => 'text-align: center;')) %>
+  <% if panel %>
+  <table style="margin-left: auto; margin-right: auto;">
+    <% panel.select { |k, _| k =~ /^or_\d+$/ }.each_with_index do |(or_key, or_val), idx1| %>
+      <% or_val.each_with_index do |(and_key, and_val), idx2| %>
+      <tr>
+        <td>
+          <%= submit_tag '∇', :name => "query[add_or]", :style => 'color: purple;' if idx1 == 0 && idx2 == 0 %>
+          <%= submit_tag '-', :name => "query[remove_#{or_key}]", :style => 'color: red;' if idx1 != 0 && idx2 == 0 %>
+        </td>
+        <td><%= select_tag "query[#{or_key}][#{and_key}][column]", options_for_select(panel[:columns].keys, and_val[:column]) %></td>
+        <td><%= select_tag "query[#{or_key}][#{and_key}][operator]", options_for_select(DynamicQuery::OPERATOR, and_val[:operator]), :class => 'query_op' %></td>
+        <td>
+          <% if ['IS NULL', 'IS NOT NULL'].include? and_val[:operator] %>
+            <%= text_field_tag "query[#{or_key}][#{and_key}][value1]", '', :style => 'display: none;' %>
+          <% else %>
+            <%= text_field_tag "query[#{or_key}][#{and_key}][value1]", and_val[:value1] %>
+          <% end %>
+        </td>
+        <td>
+          <% if ['BETWEEN', 'NOT BETWEEN'].include? and_val[:operator] %>
+            <%= text_field_tag "query[#{or_key}][#{and_key}][value2]", and_val[:value2] %>
+          <% else %>
+            <%= text_field_tag "query[#{or_key}][#{and_key}][value2]", '', :style => 'display: none;' %>
+          <% end %>
+        </td>
+        <td>
+          <%= submit_tag '+', :name => "query[#{or_key}-and]", :style => 'color: blue;' if idx2 == 0 %>
+          <%= submit_tag 'x', :name => "query[#{or_key}-#{and_key}]", :style => 'color: green;' if idx2 != 0 %>
+        </td>
+      </tr>
+      <% end %>
+      <tr style="height: 10px;"></tr>
+    <% end %>
+  <% end %>
+  </table>
+  <br />
+  <%= submit_tag 'Query', :style => 'width: 150px;'%>
+</form>

data/app/helpers/dynamic_query_helper.rb

@@ -0,0 +1,9 @@
+module DynamicQueryHelper
+  
+  def dynamic_query(panel, opt = {})
+    template = ERB.new(File.read(File.dirname(__FILE__) + '/dynamic_query.erb'))
+    content = template.result(binding)
+    content.html_safe
+  end
+  
+end

data/lib/dynamic_query/version.rb

@@ -3,7 +3,7 @@ class DynamicQuery
   module Version
     MAJOR = 0
     MINOR = 1
-    PATCH = 0
+    PATCH = 1
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

data/lib/dynamic_query.rb

@@ -1,4 +1,5 @@
 require 'dynamic_query/railtie' if defined?(Rails)
+require 'generators/helper_generator' if defined?(Rails)
 
 module DynamicQuery
   OPERATOR = ['=', '>', '>=', '<', '<=', '!=',

data/lib/generators/helper_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+
+module DynamicQuery
+  
+  class HelperGenerator < Rails::Generators::Base
+    source_root File.expand_path("../../../", __FILE__)
+  
+    def manifest
+      copy_file "app/helpers/dynamic_query_helper.rb", "app/helpers/dynamic_query_helper.rb"
+      copy_file "app/helpers/dynamic_query.erb", "app/helpers/dynamic_query.erb"
+    end
+    
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamic_query
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -119,12 +119,15 @@ files:
 - README.md
 - Rakefile
 - app/assets/javascripts/dynamic_query.js
+- app/helpers/dynamic_query.erb
+- app/helpers/dynamic_query_helper.rb
 - lib/dynamic_query.rb
 - lib/dynamic_query/dynamic_query.erb
 - lib/dynamic_query/helper.rb
 - lib/dynamic_query/railtie.rb
 - lib/dynamic_query/version.rb
 - lib/generators/dynamic_query_generator.rb
+- lib/generators/helper_generator.rb
 homepage: http://github.com/wnameless/dynamic_query
 licenses:
 - Apache License, Version 2.0
@@ -140,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -611360296909739504
+      hash: -2211947115688522246
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -152,5 +155,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: dynamic_query-0.1.0
+summary: dynamic_query-0.1.1
 test_files: []