reportly 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a38a9e9dff8b088244834bc6735b82f3aa574a8
-  data.tar.gz: 4222d9fcd393396de4cc31f45c7a31d00dcd62e3
+  metadata.gz: 52638256deac9c21a8f89abf855aa334d0d77b6e
+  data.tar.gz: e6fc77eaa0f6f4402186090774059239df2dafc9
 SHA512:
-  metadata.gz: 3838c24e4448f7a0ad4805d8bdf8377dc4293e88a004cbe0f15c947c503341d2cd29ae057e20f714425c4b3a16040d70730d75f698d321c5d7e9afd956da181d
-  data.tar.gz: 1c9ed0dcea838a1f64a629abda931fa5961322b585440c0f8510670a14dd80e0d6a86cade2088c601ea3fef979767110c4432da9bbe5e35ee70297cf71419965
+  metadata.gz: 5bed6e03bc4d694192d742f0bcdcbf2aa8b77d9a3761f43b4ba1658ec42ebf31702c4e2ec648c8d2d24186b467d8a3feb38101c23509913863d511b478100775
+  data.tar.gz: 3c44aea856d38cba204ce888f1c5dab6cda3c925f53d93dca567e4797e4933135942628fc87caa98b59a59298903dd92a1a2cda8a7c980328a6e04e888f34192

data/README.md

@@ -1,7 +1,8 @@
-[![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)
+[![Build Status](https://travis-ci.org/msroot/reportly.svg?branch=master)](https://travis-ci.org/msroot/reportly) 
 [![Code Climate](https://codeclimate.com/github/msroot/reportly/badges/gpa.svg)](https://codeclimate.com/github/msroot/reportly)
-
+[![Inline docs](http://inch-ci.org/github/msroot/reportly.svg?branch=master)](http://inch-ci.org/github/msroot/reportly)
+[![Coverage Status](https://coveralls.io/repos/msroot/reportly/badge.svg?branch=master)](https://coveralls.io/r/msroot/reportly?branch=master)
 # Reportly
 
 Reports for Active Record results! No configurations needed

data/lib/reportly/console_methods.rb

@@ -2,27 +2,54 @@ require "reportly/engine"
 
 module Reportly
   module ConsoleMethods
+    extend self    
     
     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
+    def report(model, *fields)
+      
+      model = make_array_for(model)
+      
+      validate(model)
+      report = Reportly::Engine.report(model, *fields)
+      @results = report
+      puts report.join("\n")
+    end
     
-      Reportly::Engine.report(model, *fields)
+    def results
+      @results
+    end
+
+    def make_array_for(model)
+      # report User.first
+      # 2.1.3 :003 >   User.first.class
+      #  => User(id: uuid, partner_id: uuid, created_at: datetime, updated_at: datetime)
+      model = [model] if model.class.superclass == ActiveRecord::Base
+      # report User
+      # 2.1.3 :004 > User.class
+      #  => Class
+      model = model.send(:all) if model.class.name == 'Class' and model.respond_to? :all
+      
+      # User.all.first(2) and User.where(name: 'yannis') are kind of arrays and respond to :each
+      
+      # 2.1.3 :006 > User.first(2).class
+      #  => Array
+       
+      # 2.1.3 :013 > User.all.class
+      #  => User::ActiveRecord_Relation
+      model
+      
     end
     
+    def validate(model)
+      raise ReportlyNotValid, "Reportly accepts only ActiveRecord Objects" unless is_valid_klass?(model)
+    end
 
-    def self.is_valid_klass?(klass)
-      klass.descends_from_active_record? rescue false or klass.is_a?(Array)
+    # accepts Array or a ActiveRecord_Relation
+    # Should respond_to? :each and be descend from active record
+    def is_valid_klass?(model)
+      model.first.class.descends_from_active_record? rescue false and  model.respond_to? :each
     end        
-    
+
   end
 end
-

data/lib/reportly/engine.rb

@@ -12,20 +12,23 @@ module Reportly
         end
       end
 
+      report = []
+      
       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
+      report << border
+      report <<  title_row
+      report << border
 
       items.each do |item|
         row = '| ' + fields.map {|f| sprintf("%-#{max_len[f]}s", item.read_attribute(f)) }.join(' | ') + ' |'
-        puts row
+        report <<  row
       end
 
-      puts border
-      puts "#{items.length} rows in set\n"
+      report << border
+      report <<  "#{items.length} rows in set"
+      report
     end
   end
 end

data/lib/reportly/version.rb

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

data/reportly.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   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_development_dependency "coveralls", "~> 0.7.11"  
   spec.add_runtime_dependency "rails", "~> 4.1.8"
 
 end

data/spec/reportly_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'active_record'
 require 'rails/console/helpers'
 
-NAMESPACE = Reportly::ConsoleMethods
+REPORTLY = Reportly::ConsoleMethods
     
 def run_migrations!
   ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")  
@@ -16,12 +16,12 @@ def run_migrations!
 end
 
 
-def create_user_class
+def create_users_class
   run_migrations!
   user = Class.new(ActiveRecord::Base)
   user.table_name =  :users
   2.times {user.create}
-  user
+  user.all
 end
 
 
@@ -29,7 +29,8 @@ end
 describe Reportly do
   
   let(:irb_context) {Object.new.extend(Rails::ConsoleMethods)}
-  let(:users) {create_user_class}
+  let(:users) {create_users_class}
+  
   let(:user) {
     user = Class.new(ActiveRecord::Base)
     user.table_name =  :users
@@ -43,26 +44,22 @@ describe Reportly do
   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)
+    [Hash, Object].each do |o|
+      expect{irb_context.report o.new}.to raise_error(REPORTLY::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
+  it 'not raise error on users' 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)
+  it 'not raise error on user class' do
+    expect{irb_context.report user}.to_not raise_error
   end
 
+
   it 'accepting active record array ' do
-    expect{irb_context.report users.all.first(2)}.to_not raise_error
+    expect{irb_context.report users.first(2)}.to_not raise_error
   end
   
   it 'accepting active record array ' do
@@ -73,21 +70,81 @@ describe Reportly do
   it 'passing fields ' do
     expect{irb_context.report users, :id, :name}.to_not raise_error
   end
+  
+  it 'respond to each' do
+    [user, users, users.first(2), users.first].each do |valid|
+      expect(REPORTLY.make_array_for(valid).respond_to?(:each)).to be true
+    end
+  end
 
 
-  describe "Validations" do
+  it 'should be valid ' do
+    [user, users, users.first(2), users.first].each do |valid|
 
-    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
+      model = REPORTLY.make_array_for(valid)
+        
+      expect(REPORTLY.is_valid_klass?(model)).to be true 
     end
+  end
+    
+  it 'should not raise in validation ' do
+    expect(REPORTLY.is_valid_klass?(nil)).to be false 
+    expect{REPORTLY.is_valid_klass?(nil)}.to_not raise_error
+  end
+    
+    
     
-    it 'should not be valid ' do
-      [Hash.new, Class.new].each do |valid|
-        expect(NAMESPACE.is_valid_klass?(valid)).to be false 
-      end
+  it 'should not be valid ' do
+    [String, Set, Hash, Class, Array].each do |klass|
+      expect(REPORTLY.is_valid_klass?(klass.new)).to be false 
+      expect{REPORTLY.is_valid_klass?(klass.new)}.to_not raise_error
     end
-   
+      
+    ["", [], {}].each do |klass|
+      expect(REPORTLY.is_valid_klass?(klass)).to be false 
+      expect{REPORTLY.is_valid_klass?(klass)}.to_not raise_error
+    end
+      
   end
+
+
+  let(:users_table) {
+    t = []
+    t << "+----+------+"
+    t << "| id | name |"
+    t << "+----+------+"
+    t << "| 1  |      |"
+    t << "| 2  |      |"
+    t << "+----+------+"
+    t << "2 rows in set"
+    t
+  }
+
+  let(:user_table) {
+    t = []
+    t << "+----+"
+    t << "| id |"
+    t << "+----+"
+    t << "| 1  |"
+    t << "+----+"
+    t << "1 rows in set"
+    t
+  }
+
+  # Not thread safe 
+  it 'all table' do
+    irb_context.report(users)
+    expect(REPORTLY.results).to eq(users_table)
+  end
+    
+  it 'using first' do
+    irb_context.report(users.first, :id)
+    expect(REPORTLY.results).to eq(user_table)
+  end
+    
+  it 'using find' do
+    irb_context.report(users.find(1), :id)
+    expect(REPORTLY.results).to eq(user_table)
+  end
+  
 end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reportly
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Yannis Kolovos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-24 00:00:00.000000000 Z
+date: 2015-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.11
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement