to_ascii 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f6cda9dc0082ac6275a254fa8bd4ab2ce7b3927
-  data.tar.gz: 5bdd348613fddbd9d3e7a69ec9c24a2df0d1e134
+  metadata.gz: 91a86e677bdf4a1f775a8ef679d6b0e57fc54c2f
+  data.tar.gz: 2ec7fa498cd26c88412803f5169d402ca2a9eb59
 SHA512:
-  metadata.gz: ff6e9e037d396ac2100fec23c2d5272bf64375a90a9adc5c723e10e32e4e8ace8ba2ab820698d8c8460d49768bd2a9e6ad26410b9cf28c7fbe30d3ef700f0930
-  data.tar.gz: 2ba269b77b83ca606bf73b6cb2190a4c955cfaf46bd0478f05afdff21ea55e4c95cf6f10cea417cb64ed2b85e4207883975e3950351600c1f2eb2d65b64637f9
+  metadata.gz: 54c53215b6ea7d57bdecc7c9809be9e37117534af7f772faf834648a156d2678dcd6a98a0e58e375058d0692a8c62e13b27987dd3c2aa28df2a6c776be398106
+  data.tar.gz: b2a4a08fafd0d4763233c469b63f60369f1fc73cb2ad90969ae6e1b6742d379d70ea58c442edacc4f4d37eab90772ccd61f6d91b558d76788c28af9b3fae83d3

data/README.md

@@ -1,6 +1,7 @@
 # ToAscii
 
-TODO: Write a gem 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.
 
 ## Installation
 
@@ -18,11 +19,45 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Require an adapter. By default the `to_ascii` method doesn't get added to anything until you require
+one of the following:
+
+    require 'to_ascii/adapters/active_record'
+    require 'to_ascii/adapters/enumerable'
+    require 'to_ascii/adapters/array'
+    require 'to_ascii/adapters/all' # requires all of the above
+
+Then:
+
+    Person.where(:last_name => 'Newton').to_ascii do
+      column :id, 6 # number is the column width
+      column :first_name, 24
+      column :last_name, 32
+    end
+
+You can also define visitor/serializer classes based on model names:
+
+    class PersonToAscii < ToAscii::Visitor
+      column :id, 6
+      column :first_name, 24
+      column :last_name, 32
+    end
+
+And then `Person.where(:last_name => 'Newton').to_ascii` just works. Look, ma! No block!
+
+Or, create visitor classes that are called whatever and pass them into `#to_ascii` yourself!
+
+    class GarblyNamed < ToAscii::Visitor
+      column :id, 6
+      column :first_name, 24
+      column :last_name, 32
+    end
+
+`Person.where(:last_name => 'Newton').to_ascii(GarblyNamed)`
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/to_ascii/fork )
+1. Fork it ( http://github.com/thejayvm/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`)

data/lib/to_ascii/adapters/active_record.rb

@@ -6,7 +6,5 @@ module ToAscii::Adapters::ActiveRecordExtensions
   end
 end
 
-ActiveSupport.on_load(:active_record) do
-  ActiveRecord::Base.send(:extend, ToAscii::ClassExtensions)
-  ActiveRecord::Base.send(:extend, ToAscii::Adapters::ActiveRecordExtensions)
-end
+ActiveRecord::Base.send(:extend, ToAscii::ClassExtensions)
+ActiveRecord::Base.send(:extend, ToAscii::Adapters::ActiveRecordExtensions)

data/lib/to_ascii/version.rb

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

data/to_ascii.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   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.homepage      = "http://github.com/thejayvm/to_ascii"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: to_ascii
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jason Wall
@@ -94,7 +94,7 @@ files:
 - spec/to_ascii/adapters/array_spec.rb
 - spec/to_ascii/class_extensions_spec.rb
 - to_ascii.gemspec
-homepage: ''
+homepage: http://github.com/thejayvm/to_ascii
 licenses:
 - MIT
 metadata: {}