output_attributes 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5853821c644c05df3134cba84d1fb800540eafe828ee11cbb6e17f4bb1d80fcd
-  data.tar.gz: 5b9acc26991eb9f52a1e93633badb9761564b9393cfa1a5a713f453f15c45e30
+  metadata.gz: 2ca0d8769aa2e316843cad1728211dbc7d0fb35165927b04a7c6d99d00cd2046
+  data.tar.gz: f8ee1ee5cd330c5deca707dcf34456a3d771f2a2456428c0e17cd3e96edff40f
 SHA512:
-  metadata.gz: 0cd70015e649d210c073ee061b6691823642c6ac5dcb7e03ed84ca5089759f56d9b67ac690223d5e48b94089ffcb5fb9f81daffa8d0c920e25606c0d2105bd2e
-  data.tar.gz: 30cc7fd8b45ea679001cf3e32ad977222ce0643109643b0c021ef4a19b1f5ed577bfbe3a01d84f49d34d5ae0ef66a9e6c7a7a2808b11a1b88a6fd12779b9756a
+  metadata.gz: d8c06caab668a52cd446b8e045f9add37e3d141bb630745ea7aacf59f9d0fc31ef62aefa0cd6c334d13d3c8ab7da142cdaee9b0d994c817f988811541a089ffa
+  data.tar.gz: 4601bc74afad5daf820795bd65438113a9d92722eb398ac26546916294317aaed3eab7407c4d8c364343b0d3ab3b26bed8ae1891e9b8e04dcd3b85232cce97a3

data/Gemfile.lock

@@ -12,7 +12,7 @@ GEM
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rake (10.5.0)
+    rake (13.0.1)
 
 PLATFORMS
   ruby
@@ -22,7 +22,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   output_attributes!
   pry
-  rake (~> 10.0)
+  rake (~> 13.0)
 
 BUNDLED WITH
    2.0.2

data/README.md

@@ -1,10 +1,32 @@
 # OutputAttributes
 
-This gem provides a class macro that adds `output` helpers when defining your class. I find it jarring to keep `#to_hash` up to date on classes that have many data attributes, and a few helper methods. I often wish to just mark a method as "This method describes my data and should be part of `#to_hash`".
+This gem helps you serialize your data object by providing an `output` class macro for defining your class. You can call `#output_attributes` to get a hash representing your object from the output helpers.
+
+I find it jarring to keep `#to_hash` up to date on classes that have many data attributes, and a few helper methods. I often wish to just mark a method as "This method describes my data and should be part of `#to_hash`".
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'output_attributes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install output_attributes
+
+## Usage
 
 Behold:
 
 ```ruby
+require 'output_attributes'
+
 class Item
   include OutputAttributes
 
@@ -157,9 +179,16 @@ class Page < SimpleDelegator
     labels(:size)
   end
 
-  output :extracted_at, from: ->(_){ Time.now }
+  output def description
+    "#{name} #{size} #{color}"
+  end
 
-  alias to_hash output_attributes
+  def to_hash
+    output_attributes.merge(
+      extracted_at: Time.now,
+      object: self.class
+    )
+  end
 
   private
   def labels(key)
@@ -171,7 +200,9 @@ end
 Page.new(nokogirilike).to_hash
 ```
 
-Usually when I'm writing a method for a page object, I'm thinking "Is this part of my data output, or is this just a helper method?". I've often forgotten to update `#to_hash` when it lives further away from the method itself. I've also tried other styles that involved packaging my data methods into a module, and then doing something like `Attributes.public_instance_methods.reduce({})...` but I wanted to give this style a spin.
+Usually when I'm writing a method for a page object, I'm already thinking "Is this part of my data output, or is this just a helper method?". I've often forgotten to update `#to_hash` when it lives far away from the method itself.
+
+I've also tried other styles that involved packaging my data methods into a module, and then doing something like `Attributes.public_instance_methods.reduce({})...` but I wanted to give this style a spin. For now, I like it well enough.
 
 
 # Fun Fact
@@ -184,24 +215,7 @@ memoize def my_method
 end
 ```
 
-I think this is pretty cool, and is exactly the type of syntax I wanted when creating data objects.
-
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'output_attributes'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install output_attributes
+I think this is pretty cool. It's exactly the type of syntax I usually wished I had when creating data objects.
 
 ## Development
 

data/lib/output_attributes/version.rb

@@ -1,3 +1,3 @@
 module OutputAttributes
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/output_attributes.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "pry"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: output_attributes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tim Tilberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-26 00:00:00.000000000 Z
+date: 2020-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Easily declare a hash to represent your object using `output` attributes