query_result_presenter 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzM2NmIxZWVhNWRmZGFmODJlZWY4NjJhZjQzM2U2M2ZiZTE1MzdkZQ==
+  data.tar.gz: !binary |-
+    NTdhZTcxNmMzNGVkMDdkMTllZmFjMmMzMjQ4MWEzMDdmNmI0ODU2Ng==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OGI4Nzc2ZDcxODQ0YjhhMTQ5MDA0MTRmMWFkYmMxMTA2YTJmMWNkMzIxNWMz
+    N2I4ZmRkNTAzYTg0YzMyYTBiNDdiZTMxZjc1OWU5MzQ4Yjc1NDQyNTBkMTI5
+    YjMyYTJlMDgzZWMyYTUxNGUxYmRhNjk2MWI4NzYxOGRiMmMzYmU=
+  data.tar.gz: !binary |-
+    NzBmYTgxNDUxNjM3ZmY4ZjdmMDUzOWViZTA3Y2M2MWE1NzBlZTdiOWJkODll
+    NDNkMTM1MDU4NmQxMjRlY2MyNzJkNDc2OTkwZDg5YzBlMDZmNGM3OTNhMTQ2
+    YWJiNzcxNTc0Njg4ZWJmNmFiOTQ2YzNlYzU0MGEzMDM3ZDY0YWE=

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in query_result_presenter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Solomon
+
+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,83 @@
+# QueryResultPresenter
+
+[![Code Climate](https://codeclimate.com/github/paperlesspost/query_result_presenter.png)](https://codeclimate.com/github/paperlesspost/query_result_presenter)
+
+This is a gem to deal with a variety of query results from the
+various database adapters that run in ruby. Most of them (pg, mysql2)
+natively return a query result in the form of an enumerable, with each
+result being a hash with the column name and row value of the query.
+
+This code adds functionality to the results of these
+database adapters, and simplifies some common things you need for
+query reporting, especially online.
+
+This gem uses the decorator
+pattern, so it adds some additional methods and delegates to the
+original result for anything it doesn't recognize.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'query_result_presenter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install query_result_presenter
+
+## Usage
+
+All you need to do is call `QueryResultPresenter::Presenter.new(result here)`
+on any query result returned as a hash, and you will get these
+additional methods. If you call an unrecognized method, it will 
+call that method on the original result object using `method_missing`.
+
+This project started as `PgResultPresenter` to be used with a postgres
+database that returnd `PgResult` objects to which we added 
+functionality. However, since we're open sourcing our BI app, and people
+will likely use non-postgres db's, this gem is to extend that
+functionality beyond just postgres.
+
+So, the `(result here)` that you load into the presenter will be a result
+from `pg`, `mysql2`, or another db connection library. The results can 
+be different types /
+classes, but most conform to the same format which allows this gem to
+work.
+
+The format needed for this to work is for results to be returned as
+hashes, this will not work for query results
+returned as an array. Most libraries return results as hashes by
+default, or you are able to change the configuration in the library to
+return the result as a hash.
+
+The additional functions you get are:
+
+`to_html_table` turns the query result to an html table
+
+`to_csv_data` gives you a csv string
+
+`to_csv_file(filename)` saves a csv file of filename. Will overwrite
+previous files
+
+`headers` gets you the headers of the query result (column names)
+
+`field_values(column)` gets you the values of an individual column as an
+array
+
+`first_result_row` gets you the first row of the result
+
+`has_results?` returns true if there are results
+
+`result_count` returns the number of results
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+task :default => [:test]

data/lib/query_result_presenter.rb

@@ -0,0 +1,115 @@
+require "query_result_presenter/version"
+require 'csv'
+
+# This is a module to deal with a variety of query results from the
+# various database adapters that run in ruby. Most of them (pg, mysql2)
+# natively return a query result in the form of an enumerable, with each
+# result being a hash with the column name and row value of the query.
+#
+# This code is to allow you to add functionality to the results of these
+# database adapters, and automate certain common things you need for
+# query reporting, especially online.
+module QueryResultPresenter
+  class Presenter
+    attr_reader :result
+
+    def initialize(result)
+      @result = result
+    end
+
+    # Get the csv data in the form of a string
+    # @return [String]
+    def to_csv_data
+      has_results? ? csv_data : ""
+    end
+
+    # Saves a query result to file. Will overwrite any file with the
+    # same name
+    # @param [String] filename the name of the file eg 'file.csv'
+    def to_csv_file(filename)
+      File.open(filename, "w"){ |f| f.puts csv_data }
+    end
+
+    # Returns the query result as an html table string
+    # @return [String]
+    def to_html_table
+      html_table = "<table>"
+      html_table << add_html_row(headers)
+      @result.each do |row|
+        html_table << add_html_row(row.values)
+      end
+      html_table << "</table>"
+      html_table
+    end
+
+    # Returns the column names from the query result
+    # @return [Array]
+    def headers
+      @result.first.keys
+    end
+
+    # Gets the values in every row for a specific column
+    # @param [String] column_name
+    # @return [Array]
+    def field_values(column_name)
+      @result.to_a.map{ |r| r[column_name] }
+    end
+
+    # Gets the first row from the query result
+    # @return [Array]
+    def first_result_row
+      @result.first.values
+    end
+
+    # Does this query have any results?
+    # @return [Boolean]
+    def has_results?
+      result_count > 0
+    end
+
+    # How many rows are in the query result
+    # @return [Integer]
+    def result_count
+      @result.count
+    end
+
+    # Will delegate to the underlying object if a method can't be found
+    def method_missing(method, *args, &block)
+      @result.send(method, *args, &block)
+    end
+
+    # Will be true if either this class or the underlying object
+    # responds to a method, false otherwise
+    # @return [Boolean]
+    def respond_to?(method, include_private = false)
+      super || @result.respond_to?(method, include_private)
+    end
+
+    private
+
+    # Returns an array as an html row
+    # @param [Array] row_data the array you want to turn into a row
+    # @return [String]
+    def add_html_row(row_data)
+      row = "<tr>"
+      row_data.each do |d|
+        row << "<td>#{d}</td>"
+      end
+      row << "</tr>"
+      row
+    end
+
+    # Get the csv data in the form of a string
+    # @return [String]
+    def csv_data
+      csv_data = CSV.generate do |csv|
+        csv << headers
+        @result.each do |r|
+          csv << r.values
+        end
+      end
+      csv_data
+    end
+
+  end
+end

data/lib/query_result_presenter/version.rb

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

data/query_result_presenter.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'query_result_presenter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "query_result_presenter"
+  spec.version       = QueryResultPresenter::VERSION
+  spec.authors       = ["Solomon"]
+  spec.email         = ["solomon.kahn@gmail.com"]
+  spec.description   = %q{Works with query results in hash form. In particular, made to work with the pg gem, but will also work with any query result represented as a hash.}
+  spec.summary       = %q{Adds some functionality to query results using the presenter pattern. Delegates to the underlying object using method missing for a non-recognized method.}
+  spec.homepage      = "https://www.github.com/paperless-post/query_result_presenter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/query_result_presenter_test.rb

@@ -0,0 +1,87 @@
+require 'test_helper'
+
+class QueryResultPresenterTest < Test::Unit::TestCase
+  context "Query Result Presenter" do
+    setup do
+      @result = [
+        {"column1" => "row1", "column2" => "row1"},
+        {"column1" => "row2", "column2" => "row2"},
+        {"column1" => "row3", "column2" => "row3"}
+      ]
+      @presenter = QueryResultPresenter::Presenter.new(@result)
+    end
+
+    context "headers" do
+      should "have the correct headers" do
+        headers = ["column1", "column2"]
+        assert_equal(headers, @presenter.headers)
+      end
+    end
+
+    context "first_result_row" do
+      should "have the correct result row" do
+        assert_equal(["row1", "row1"], @presenter.first_result_row)
+      end
+    end
+
+    context "to_html_table" do
+      should "show correct table" do
+        table = "<table><tr><td>column1</td><td>column2</td></tr><tr><td>row1</td><td>row1</td></tr><tr><td>row2</td><td>row2</td></tr><tr><td>row3</td><td>row3</td></tr></table>"
+        assert_equal(table, @presenter.to_html_table)
+      end
+    end
+
+    context "to_csv_data" do
+      should "return csv data in the form of a string" do
+        csv = "column1,column2\nrow1,row1\nrow2,row2\nrow3,row3\n"
+        assert_equal(csv, @presenter.to_csv_data)
+      end
+    end
+
+    context "field_values" do
+      should "have the correct field values" do
+        assert_equal(["row1", "row2", "row3"], @presenter.field_values('column2'))
+      end
+    end
+
+    context "has_results?" do
+      should "return true when there are results" do
+        assert_equal(true, @presenter.has_results?)
+      end
+    end
+
+    context "result_count" do
+      should "return the correct number of results" do
+        assert_equal(3, @presenter.result_count)
+      end
+    end
+
+    context "method_missing" do
+      should "delegate to the underlying result if method is missing" do
+        @result.expects(:to_a)
+        @presenter.to_a
+      end
+
+      should "raise an error when calling an unknown method" do
+        assert_raise NoMethodError do
+          @presenter.not_a_method
+        end
+      end
+    end
+
+    context "respond_to?" do
+      should "be true for presenter methods" do
+        assert @presenter.respond_to?(:headers)
+      end
+
+      should "be true for underlying methods" do
+        assert @presenter.respond_to?(:to_a)
+      end
+
+      should "be false for unknown methods" do
+        refute @presenter.respond_to?(:not_a_method)
+      end
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+dir = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift dir + '/../lib'
+
+require 'test/unit'
+require "mocha/setup"
+require "shoulda-context"
+
+require "query_result_presenter"

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: query_result_presenter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Solomon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: Works with query results in hash form. In particular, made to work with
+  the pg gem, but will also work with any query result represented as a hash.
+email:
+- solomon.kahn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/query_result_presenter.rb
+- lib/query_result_presenter/version.rb
+- query_result_presenter.gemspec
+- test/query_result_presenter_test.rb
+- test/test_helper.rb
+homepage: https://www.github.com/paperless-post/query_result_presenter
+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: Adds some functionality to query results using the presenter pattern. Delegates
+  to the underlying object using method missing for a non-recognized method.
+test_files:
+- test/query_result_presenter_test.rb
+- test/test_helper.rb
+has_rdoc: