to_ascii 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f6cda9dc0082ac6275a254fa8bd4ab2ce7b3927
+  data.tar.gz: 5bdd348613fddbd9d3e7a69ec9c24a2df0d1e134
+SHA512:
+  metadata.gz: ff6e9e037d396ac2100fec23c2d5272bf64375a90a9adc5c723e10e32e4e8ace8ba2ab820698d8c8460d49768bd2a9e6ad26410b9cf28c7fbe30d3ef700f0930
+  data.tar.gz: 2ba269b77b83ca606bf73b6cb2190a4c955cfaf46bd0478f05afdff21ea55e4c95cf6f10cea417cb64ed2b85e4207883975e3950351600c1f2eb2d65b64637f9

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jason Wall
+
+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,29 @@
+# ToAscii
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'to_ascii'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install to_ascii
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/to_ascii/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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/to_ascii.rb

@@ -0,0 +1,9 @@
+require "to_ascii/version"
+require 'active_support'
+require 'active_support/core_ext'
+
+module ToAscii
+  require 'to_ascii/class_extensions'
+  require 'to_ascii/visitor'
+  require 'to_ascii/adapters'
+end

data/lib/to_ascii/adapters.rb

@@ -0,0 +1 @@
+module ToAscii::Adapters; end

data/lib/to_ascii/adapters/active_record.rb

@@ -0,0 +1,12 @@
+require 'to_ascii'
+
+module ToAscii::Adapters::ActiveRecordExtensions
+  def to_a_for_ascii
+    where(nil).to_a
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Base.send(:extend, ToAscii::ClassExtensions)
+  ActiveRecord::Base.send(:extend, ToAscii::Adapters::ActiveRecordExtensions)
+end

data/lib/to_ascii/adapters/all.rb

@@ -0,0 +1,3 @@
+%w(active_record array enumerable).each do |f|
+  require "to_ascii/adapters/#{f}"
+end

data/lib/to_ascii/adapters/array.rb

@@ -0,0 +1,3 @@
+require 'to_ascii'
+
+Array.send(:include, ToAscii::ClassExtensions)

data/lib/to_ascii/adapters/enumerable.rb

@@ -0,0 +1,3 @@
+require 'to_ascii'
+
+Enumerable.send(:include, ToAscii::ClassExtensions)

data/lib/to_ascii/class_extensions.rb

@@ -0,0 +1,27 @@
+module ToAscii
+  module ClassExtensions
+    def to_ascii(visitor = nil, io = STDOUT, &block)
+      begin
+        visitor ||= Visitor.for_class(self) unless block_given?
+      rescue NameError => e
+        warn "Missing default visitor for #{self} and no overrides provided"
+        raise e
+      end
+      visitor ||= Visitor
+      visitor = visitor.new
+      visitor.instance_eval(&block) if block_given?
+
+      a = to_a_for_ascii # important to load before so activerecord logs don't get mixed into the table
+      visitor.headers(io)
+      a.each do |row|
+        io.puts visitor.visit(row)
+      end
+      io.puts visitor.cell_border
+      io
+    end
+
+    def to_a_for_ascii
+      to_a
+    end
+  end
+end

data/lib/to_ascii/version.rb

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

data/lib/to_ascii/visitor.rb

@@ -0,0 +1,41 @@
+module ToAscii
+  class Visitor
+    class << self
+      def for_class(clazz)
+        "#{clazz.name}ToAscii".constantize
+      end
+
+      def column(name, width)
+        columns << [name, width]
+      end
+
+      def columns
+        @columns ||= []
+      end
+    end
+
+    attr_reader :columns
+
+    def initialize
+      @columns = self.class.columns.dup
+    end
+
+    def column(name, width)
+      columns << [name, width]
+    end
+
+    def cell_border
+      @cell_border ||= "|#{columns.map { |c| '-' * c[1] }.join('|')}|"
+    end
+
+    def headers(io)
+      io.puts cell_border
+      io.puts "|#{columns.map { |c| c[0].to_s.center(c[1]) }.join('|')}|"
+      io.puts cell_border
+    end
+
+    def visit(o)
+      "|#{columns.map { |c| o.send(c[0]).to_s.center(c[1]) }.join('|')}|"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'to_ascii'
+require 'stringio'

data/spec/to_ascii/adapters/array_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'to_ascii/adapters/array'
+
+describe Array do
+  Person = Struct.new(:first_name, :last_name)
+
+  let(:people) do
+    [Person.new('Isaac', 'Newton'), Person.new('Albert', 'Einstein')]
+  end
+  let(:io) { StringIO.new }
+
+  it 'should add to_ascii to an array' do
+    people.to_ascii(nil, io) do
+      column :first_name, 16
+      column :last_name, 16
+    end
+
+    %w(Isaac Newton Albert Einstein first_name last_name).each do |word|
+      expect(io.string).to match(/#{word}/)
+    end
+  end
+end

data/spec/to_ascii/class_extensions_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe ToAscii::ClassExtensions do
+  let(:io) { StringIO.new }
+
+  class TestClass
+    extend ToAscii::ClassExtensions
+
+    def self.to_a
+      []
+    end
+  end
+
+  class ClassWithNoDefaultVisitor
+    extend ToAscii::ClassExtensions
+
+    class << self
+      attr_reader :warned
+      def warn(message)
+        @warned = true
+      end
+
+      def to_a
+        []
+      end
+    end
+  end
+
+  class TestClassToAscii < ToAscii::Visitor
+    column :to_ascii_visitor, 24
+  end
+
+  class CustomVisitor < ToAscii::Visitor
+    column :name, 32
+  end
+
+  describe '#to_ascii' do
+    it 'should work with nil visitor param' do
+      TestClass.to_ascii(nil, io)
+      expect(io.string).to match(/to_ascii_visitor/)
+    end
+
+    it 'should accept a block' do
+      ClassWithNoDefaultVisitor.to_ascii(nil, io) do
+        column :id, 10
+      end
+      expect(io.string).to match(/id/)
+      expect(io.string).to_not match(/to_ascii_visitor/)
+    end
+
+    it 'should accept a class' do
+      ClassWithNoDefaultVisitor.to_ascii(CustomVisitor, io)
+      expect(io.string).to match(/name/)
+    end
+
+    it 'should accept a combo' do
+      ClassWithNoDefaultVisitor.to_ascii(CustomVisitor, io) do
+        column :id, 10
+      end
+      expect(io.string).to match(/id/)
+      expect(io.string).to match(/name/)
+    end
+
+    it 'can take the default visitor' do
+      TestClass.to_ascii(TestClassToAscii, io) do
+        column :id, 10
+      end
+      expect(io.string).to match(/id/)
+      expect(io.string).to match(/to_ascii_visitor/)
+    end
+
+    it 'should raise an error when no default and nothing provided' do
+      expect { ClassWithNoDefaultVisitor.to_ascii }.to raise_error(NameError)
+      expect(ClassWithNoDefaultVisitor.warned).to be
+    end
+  end
+end

data/to_ascii.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'to_ascii/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "to_ascii"
+  spec.version       = ToAscii::VERSION
+  spec.authors       = ["Jason Wall"]
+  spec.email         = ["javajo@gmail.com"]
+  spec.summary       = %q{#to_ascii a collection}
+  spec.description   = %q{Adds the #to_ascii method to a number of collection type classes to print out a nicely formatted
+  ASCII table of the attributes of each element.}
+  spec.homepage      = ""
+  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_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: to_ascii
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jason Wall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: |-
+  Adds the #to_ascii method to a number of collection type classes to print out a nicely formatted
+    ASCII table of the attributes of each element.
+email:
+- javajo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/to_ascii.rb
+- lib/to_ascii/adapters.rb
+- lib/to_ascii/adapters/active_record.rb
+- lib/to_ascii/adapters/all.rb
+- lib/to_ascii/adapters/array.rb
+- lib/to_ascii/adapters/enumerable.rb
+- lib/to_ascii/class_extensions.rb
+- lib/to_ascii/version.rb
+- lib/to_ascii/visitor.rb
+- spec/spec_helper.rb
+- spec/to_ascii/adapters/array_spec.rb
+- spec/to_ascii/class_extensions_spec.rb
+- to_ascii.gemspec
+homepage: ''
+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.14
+signing_key: 
+specification_version: 4
+summary: '#to_ascii a collection'
+test_files:
+- spec/spec_helper.rb
+- spec/to_ascii/adapters/array_spec.rb
+- spec/to_ascii/class_extensions_spec.rb