visual_query 0.3.0

data/lib/tutuf/visual_query/common.rb

@@ -0,0 +1,58 @@
+# -*- encoding : utf-8 -*-
+module Tutuf
+  module VisualQuery
+    class Common
+      class << self
+        def connection
+          ActiveRecord::Base.connection
+        end
+
+        #delegates to PostgreSQL raw connection
+        def quote_ident(str)
+          connection.raw_connection.quote_ident(str)
+        end
+
+        def quote_relation_name(name)
+          if String === name # in default schema
+            quote_ident(name)
+          elsif Hash === name
+            "#{!name['schema'].blank? ? quote_ident(name['schema']) + '.' : ''}#{quote_ident(name['rel_name'])}"
+          end
+        end
+      end
+
+      # Parameters of the block: +schema+, +relation_name+, +column_name+, +operator+, +value+
+      def filters_to_a(&block)
+        parse_filters(filters, &block)
+      end
+
+      protected
+        def connection
+          self.class.connection
+        end
+
+        def quote_ident(str)
+          self.class.quote_ident(str)
+        end
+
+        def quote_relation_name(name)
+          self.class.quote_relation_name(name)
+        end
+
+        def parse_filters(filters)
+          return [] if filters.blank? || (Hash === filters) # old version
+          res = []
+          filters.each do |filter|
+            schema, rel_name, col_name, op, val = [filter['schema'], filter['rel_name'], filter['col_name'], filter['op'], filter['val']]
+            if (!val.blank? || ( val.blank? && op == '=' ))
+              val = "%#{val}%" if (op == 'LIKE' || op == 'ILIKE')
+              res << yield(schema,rel_name,col_name,op,val)
+            elsif op == 'IS NULL'
+              res << yield(schema,rel_name,col_name,"IS","NULL")
+            end
+          end
+          res
+        end
+    end
+  end
+end

data/lib/tutuf/visual_query/metadata.rb

@@ -0,0 +1,35 @@
+# -*- encoding : utf-8 -*-
+module Tutuf
+  module VisualQuery
+    class Metadata < ActiveRecord::Base
+      self.table_name =  'tutuf_visual_query_metadata'
+
+      class JSON
+        def load(text)
+          ::JSON.parse(text)
+        end
+
+        def dump(text)
+          ::JSON.dump(text)
+        end
+      end
+
+      serialize :params, JSON.new
+
+      validates :name, :presence => true,
+                       :uniqueness => true,
+                       :length => { :maximum => 63, :too_long  => "не може да е по-дълго от 63 байта" }
+
+      default_scope -> { order(:name) }
+
+      before_save do
+        %w(controller action authenticity_token sort_conditions utf8).each{ |p| params.delete(p) }
+        return true
+      end
+
+      def locked?
+        params['readonly']
+      end
+    end
+  end
+end

data/lib/tutuf/visual_query/single.rb

@@ -0,0 +1,111 @@
+# -*- encoding : utf-8 -*-
+module Tutuf
+  module VisualQuery
+    class Single < Common
+      def initialize(params)
+        @relations = parse_relations(params['relations'])
+        @filters = params['filters']
+        @parsed_filters = filters_to_a do |schema, rel_name, col_name, op, val|
+          "#{quote_column_name('schema' => schema, 'rel_name'=>rel_name,'col_name' => col_name)} #{sanitize_operator(op)} #{ val == 'NULL' ?  val : quote(val) }"
+        end.join(" AND ")
+        @join_conditions = params['join_conditions']
+        if params['action'] == "create"
+          @parsed_columns = columns_to_sql_for_saving(params['columns'],params['all_columns'],params['all_selected_columns'],params['balanced'])
+        else
+          @parsed_columns = columns_to_sql(params['columns'],params['all_columns'])
+        end
+
+        @sort_conditions = []
+        unless params['sort_conditions'].blank?
+          params['sort_conditions'].map do |key, val|
+            if params['all_columns'].detect{ |all| val['rel_name'] == all['rel_name'] && val['col_name'] == all['col_name']  } &&
+               ( val['direction'].blank? || val['direction'] == 'ASC' || val['direction'] == 'DESC' )
+                 @sort_conditions[key.to_i] = val
+            end
+          end
+          @sort_conditions.compact!
+        end
+      end
+
+      attr_reader :parsed_columns, :relations, :parsed_filters, :filters, :join_conditions
+
+      def query
+        return nil if relations.nil? || relations.empty?
+        # debugger
+        query_string = "SELECT #{parsed_columns} FROM #{join_relations}"
+        query_string += " WHERE #{parsed_filters}" unless parsed_filters.blank?
+        query_string += " ORDER BY #{@sort_conditions.map{ |sc| "#{quote_ident(sc['rel_name'])}.#{quote_ident(sc['col_name'])} #{sc['direction']}" }.join(',')}" unless @sort_conditions.blank?
+        query_string.force_encoding('UTF-8')
+      end
+
+      protected
+
+        def quote(str)
+          ActiveRecord::Base.sanitize(str)
+        end
+
+        def quote_column_name(qn)
+          "#{qn['schema'] ? quote_ident(qn['schema']) + '.' : ''}#{quote_ident(qn['rel_name'])}.#{quote_ident(qn['col_name'])}"
+        end
+
+      private
+        def sanitize_operator(str)
+          if %w(AND OR LIKE ILIKE IS >= >  = < <= != <>).member?(str)
+            return str
+          else
+            raise %(Unrecognized operator "#{str}" in SQL query. Possible injection attack!)
+          end
+        end
+
+        def sanitize_join_type(str)
+          if %w(INNER LEFT RIGHT FULL).member?(str)
+            return str
+          else
+            return "INNER"
+          end
+        end
+
+        def columns_to_sql(selected,all)
+          return if selected.blank? || all.blank?
+          all.map{|c| selected.member?(c) ? quote_column_name(c) : "NULL"}.join(",")
+        end
+
+        # TODO: select proper cols in columns_to_sql_for_saving for balanced queries
+        def columns_to_sql_for_saving(selected,all_selected,all,balanced = false)
+          return if selected.blank?
+          if balanced
+            all.map do |c|
+              if selected.member?(c)
+                "#{quote_column_name(c)} AS #{quote_ident(c['save_name'])}"
+              elsif !all_selected.member?(c) && relations.map{|r| r['rel_name']}.member?(c['rel_name']) # c is hidden column
+                nil
+              else # c is not in a relation in this query
+                "NULL AS #{quote_ident(c['save_name'])}"
+              end
+            end.compact.join(",")
+          else
+            selected.map { |c| "#{quote_column_name(c)} AS #{quote_ident(c['save_name'])}"}.join(",")
+          end
+        end
+
+        def parse_relations(relations)
+          relations.map{|r| quote_relation_name(r)} unless relations.blank?
+        end
+
+        # [{'left_rel_name'=>"incoming_invoices",
+        #   'left_col_name'=>"payment_method_id",
+        #   'right_rel_name'=>"payment_methods",
+        #   'right_col_name'=>"id",
+        #   'type' => "FULL"}, ...]
+        def join_relations
+          return relations.first if join_conditions.blank?
+          join_conditions.inject("") do |res, jc|
+            res << quote_relation_name(jc['left_rel_name']) if res.blank?
+            res << " #{sanitize_join_type(jc['type'])} JOIN #{quote_relation_name(jc['right_rel_name'])}"
+            res << " ON " << %w(left right).map{|t| quote_column_name('rel_name' => jc["#{t}_rel_name"], 'col_name' => jc["#{t}_col_name"])}.join(" = ")
+            res
+          end
+        end
+    end
+  end
+end

data/lib/tutuf/visual_query/sql.rb

@@ -0,0 +1,20 @@
+# -*- encoding : utf-8 -*-
+module Tutuf
+  module VisualQuery
+    class Sql < Common
+      def initialize(params)
+        @sql = params['sql']
+      end
+
+      attr_writer :sql
+
+      def filters
+        []
+      end
+
+      def query
+        @sql
+      end
+    end
+  end
+end

data/lib/visual_query.rb

@@ -0,0 +1,4 @@
+require "visual_query/engine"
+
+module VisualQuery
+end

data/lib/visual_query/engine.rb

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

data/lib/visual_query/version.rb

@@ -0,0 +1,3 @@
+module VisualQuery
+  VERSION = "0.3.0"
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.