reportly 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a38a9e9dff8b088244834bc6735b82f3aa574a8
+  data.tar.gz: 4222d9fcd393396de4cc31f45c7a31d00dcd62e3
+SHA512:
+  metadata.gz: 3838c24e4448f7a0ad4805d8bdf8377dc4293e88a004cbe0f15c947c503341d2cd29ae057e20f714425c4b3a16040d70730d75f698d321c5d7e9afd956da181d
+  data.tar.gz: 1c9ed0dcea838a1f64a629abda931fa5961322b585440c0f8510670a14dd80e0d6a86cade2088c601ea3fef979767110c4432da9bbe5e35ee70297cf71419965

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.3

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,12 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ioannis Kolovos
+
+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,119 @@
+[![Build Status](https://travis-ci.org/msroot/reportly.svg?branch=master)](https://travis-ci.org/msroot/reportly) 
+[![Gem Version](https://badge.fury.io/rb/reportly.png)](http://badge.fury.io/rb/reportly)
+[![Code Climate](https://codeclimate.com/github/msroot/reportly/badges/gpa.svg)](https://codeclimate.com/github/msroot/reportly)
+
+# Reportly
+
+Reports for Active Record results! No configurations needed
+
+Creates a  `:report` helper method and exposed to rails console
+
+Accepts `ActiveRecord::Relation` and `ActiveRecord::Base` objects and generates a table
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reportly'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reportly
+
+## Usage
+From Rails console
+
+     report User
+or 
+
+	 report Post.all
+
+using ActiveRecord finders 
+
+	 report Admin.where(email: 'me@localhost.com'), :id
+
+or use the `:r` alias
+
+	 r Translation
+
+or by selecting fields
+
+	r Query, :text
+
+or by selecting fields on ActiveRecord objects
+
+	r Query.all.first(5), :text, :id
+
+Will generate:
+
+	+------------------+--------------------------------------+
+	| text             | id                                   |
+	+------------------+--------------------------------------+
+	| Ansley Bechtelar | a673cec9-b1f2-4ec4-8104-a0dbfca23771 |
+	| Tevin Gerlach    | 92f6c49f-4628-4dbd-9812-4b2094151ff6 |
+	| Vivien Langosh   | c452e939-4858-4113-bc3a-9db77617b11e |
+	| Kadin Hahn       | 4aed4438-434c-4761-a119-ba4a6aa3e1b6 |
+	| Brenda Huels     | c28c9bd4-74a9-491b-9897-12380c2cb3c8 |
+	+------------------+--------------------------------------+
+
+## Motivation
+
+Looking for a simple method to generate a simple report i found [this](https://gist.github.com/bgreenlee/72234)
+and i decided to make it a gem 
+
+## For RockStars only
+
+<a href="http://www.youtube.com/watch?feature=player_embedded&v=sFZjqVnWBhc
+" target="_blank"><img src="http://img.youtube.com/vi/sFZjqVnWBhc/0.jpg" width="240" height="180" border="10" /></a>
+
+
+## Todo
+
+- Create a method `Model.report` to all active record objects
+
+## Testing
+
+run `bundle` and `rake`
+
+## Authors
+
+Yannis Kolovos [@yannis_kolovos](http://twitter.com/yannis_kolovos)
+
+
+## Contributing
+
+1. Fork it ( https://github.com/msroot/reportly/fork )
+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 a new Pull Request
+
+
+## License 
+MIT License Copyright (c) 2015 Yannis Kolovos
+
+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/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+end
+
+task :default => :spec
+

data/lib/reportly.rb

@@ -0,0 +1,31 @@
+require "reportly/version"
+require "reportly/console_methods"
+
+module Rails
+  module ConsoleMethods
+    # Creates a  +:report+ method helper exposed to rails console
+    #
+    # Accepts <tt>ActiveRecord::Relation</tt> and <tt>ActiveRecord::Base</tt> objects 
+    # and generated a table
+    #
+    #Example:
+    #   report User
+    # or 
+    #   report Post.all
+    # Note <tt>:r</tt> its the alias method for <tt>:report</tt>
+    # 
+    # Usage:
+    #   report(records)  # displays report with all fields
+    #   report(records, :field1, :field2, ...) # displays report with given fields
+    #
+    # ==== Options
+    # * <tt>items</tt>   - The ActiveRecord objects
+    # * <tt>fields</tt>  - Filter only the given fields
+    
+    def report(model, *fields)
+      Reportly::ConsoleMethods.report(model, *fields)
+    end
+    
+    alias_method :r, :report
+  end
+end

data/lib/reportly/console_methods.rb

@@ -0,0 +1,28 @@
+require "reportly/engine"
+
+module Reportly
+  module ConsoleMethods
+    
+    class ReportlyNotValid < StandardError; end
+    
+    def self.report(model, *fields)
+
+      raise ReportlyNotValid, "Reportly accepts only ActiveRecord Objects" unless is_valid_klass?(model)
+    
+      # call :all for ActiveRecord::Base model
+      model = model.send(:all) unless model.is_a?(Array)
+  
+      # create a new array if its a single record
+      model = [model] unless model.respond_to? :each
+    
+      Reportly::Engine.report(model, *fields)
+    end
+    
+
+    def self.is_valid_klass?(klass)
+      klass.descends_from_active_record? rescue false or klass.is_a?(Array)
+    end        
+    
+  end
+end
+

data/lib/reportly/engine.rb

@@ -0,0 +1,31 @@
+module Reportly
+  module Engine
+    # Original code https://gist.github.com/bgreenlee/72234   
+    def self.report(items, *fields)
+      # find max length for each field; start with the field names themselves
+      fields = items.first.class.column_names unless fields.any?
+      max_len = Hash[*fields.map {|f| [f, f.to_s.length]}.flatten]
+      items.each do |item|
+        fields.each do |field|
+          len = item.read_attribute(field).to_s.length
+          max_len[field] = len if len > max_len[field]
+        end
+      end
+
+      border = '+-' + fields.map {|f| '-' * max_len[f] }.join('-+-') + '-+'
+      title_row = '| ' + fields.map {|f| sprintf("%-#{max_len[f]}s", f.to_s) }.join(' | ') + ' |'
+
+      puts border
+      puts title_row
+      puts border
+
+      items.each do |item|
+        row = '| ' + fields.map {|f| sprintf("%-#{max_len[f]}s", item.read_attribute(f)) }.join(' | ') + ' |'
+        puts row
+      end
+
+      puts border
+      puts "#{items.length} rows in set\n"
+    end
+  end
+end

data/lib/reportly/version.rb

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

data/reportly.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reportly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "reportly"
+  spec.version       = Reportly::VERSION
+  spec.authors       = ["Yannis Kolovos"]
+  spec.email         = ["yannis.kolovos@gmail.com"]
+  spec.summary       = "Reports for Active record objects"
+  spec.description   = "Generates tables from Active record objects"
+  spec.homepage      = "http://johnkolovos.blogspot.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"  
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+  spec.add_development_dependency "guard", "~> 2.12.5"
+  spec.add_development_dependency "guard-rspec", "~> 4.5.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3.10"
+
+  spec.add_runtime_dependency "rails", "~> 4.1.8"
+
+end

data/spec/reportly_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+require 'active_record'
+require 'rails/console/helpers'
+
+NAMESPACE = Reportly::ConsoleMethods
+    
+def run_migrations!
+  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")  
+  
+  m = ActiveRecord::Migration.new
+  m.verbose = false  
+  m.create_table :users do |t| 
+    t.string :name
+  end
+  
+end
+
+
+def create_user_class
+  run_migrations!
+  user = Class.new(ActiveRecord::Base)
+  user.table_name =  :users
+  2.times {user.create}
+  user
+end
+
+
+
+describe Reportly do
+  
+  let(:irb_context) {Object.new.extend(Rails::ConsoleMethods)}
+  let(:users) {create_user_class}
+  let(:user) {
+    user = Class.new(ActiveRecord::Base)
+    user.table_name =  :users
+    user
+  }
+  
+    
+  it 'respond to report' do
+    expect(irb_context).to respond_to(:report)
+    expect(irb_context).to respond_to(:r)
+  end
+  
+  it 'raise error for not active recods' do
+    [Class, Hash, Object].each do |o|
+      expect{irb_context.report o.new}.to raise_error(NAMESPACE::ReportlyNotValid)
+    end
+  end
+  
+  it 'not raise error' do
+    expect{irb_context.report users.all}.to_not raise_error
+  end
+  
+  it 'not raise error on class' do
+    expect{irb_context.report users}.to_not raise_error
+    expect{irb_context.report user}.to_not raise_error
+  end
+  
+  it 'should call :all' do
+    expect(irb_context.report users).to equal(irb_context.report users.all)
+  end
+
+  it 'accepting active record array ' do
+    expect{irb_context.report users.all.first(2)}.to_not raise_error
+  end
+  
+  it 'accepting active record array ' do
+    expect{irb_context.report users.where(id: 1)}.to_not raise_error
+  end
+  
+  
+  it 'passing fields ' do
+    expect{irb_context.report users, :id, :name}.to_not raise_error
+  end
+
+
+  describe "Validations" do
+
+    it 'should be valid ' do
+      [users, users.all, users.all.first(2)].each do |valid|
+        expect(NAMESPACE.is_valid_klass?(valid)).to be true 
+      end
+    end
+    
+    it 'should not be valid ' do
+      [Hash.new, Class.new].each do |valid|
+        expect(NAMESPACE.is_valid_klass?(valid)).to be false 
+      end
+    end
+   
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'rails'
+require 'reportly'
+
+def make_basic_app
+  @app = Class.new(Rails::Application)
+  @app.config.secret_token = "3b7cd727ee24e8444053437c36cc66c4"
+  @app.config.session_store :cookie_store, :key => "_myapp_session"
+  @app.config.active_support.deprecation = :log
+  @app.initialize!
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: reportly
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yannis Kolovos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.5
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+description: Generates tables from Active record objects
+email:
+- yannis.kolovos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/reportly.rb
+- lib/reportly/console_methods.rb
+- lib/reportly/engine.rb
+- lib/reportly/version.rb
+- reportly.gemspec
+- spec/reportly_spec.rb
+- spec/spec_helper.rb
+homepage: http://johnkolovos.blogspot.com
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Reports for Active record objects
+test_files:
+- spec/reportly_spec.rb
+- spec/spec_helper.rb