output_attributes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5853821c644c05df3134cba84d1fb800540eafe828ee11cbb6e17f4bb1d80fcd
+  data.tar.gz: 5b9acc26991eb9f52a1e93633badb9761564b9393cfa1a5a713f453f15c45e30
+SHA512:
+  metadata.gz: 0cd70015e649d210c073ee061b6691823642c6ac5dcb7e03ed84ca5089759f56d9b67ac690223d5e48b94089ffcb5fb9f81daffa8d0c920e25606c0d2105bd2e
+  data.tar.gz: 30cc7fd8b45ea679001cf3e32ad977222ce0643109643b0c021ef4a19b1f5ed577bfbe3a01d84f49d34d5ae0ef66a9e6c7a7a2808b11a1b88a6fd12779b9756a

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    output_attributes (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    method_source (0.9.2)
+    minitest (5.13.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  output_attributes!
+  pry
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -0,0 +1,214 @@
+# 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`".
+
+Behold:
+
+```ruby
+class Item
+  include OutputAttributes
+
+  def name
+    "The Name"
+  end
+  output :name
+
+end
+
+Item.new.output_attributes
+# => {:name=>"The Name"}
+```
+
+The `output` declaration can come before, during, or after a method definition.
+
+```ruby
+class Item
+  include OutputAttributes
+
+  # Before:
+  output :first_name
+
+  def first_name
+    "First Name"
+  end
+
+  # During -- this is my favorite. It leverages the fact that the `def meth` expression returns a symbol... Clever!
+  output def middle_name
+    "Middle Name"
+  end
+
+  # After
+  def last_name
+    "Last Name"
+  end
+
+  output :last_name
+end
+
+Item.new.output_attributes
+# => {:first_name=>"First Name",
+#  :middle_name=>"Middle Name",
+#  :last_name=>"Last Name"}
+```
+
+Whatever style works best for you. Stack a bunch on top like typical `attr_readers`. Stash them on the bottom. Decorate them. It's all good.
+
+Sometimes the method name is not what you want as your output key. `output` takes an optional `from: ` keyword argument. If `from` is a `Symbol`, it will call that method instead:
+
+```ruby
+class Item
+  include OutputAttributes
+  def name
+    "An Item"
+  end
+
+  output :description, from: :name
+end
+
+Item.new.output_attributes
+# => {:description=>'An Item'}
+```
+
+You can also pass a proc or lambda in. The first argument provided to the proc is the instance of the object. This can be helpful if you need just a little extra massaging.
+
+```ruby
+class Item
+  include OutputAttributes
+  def name
+    "An Item"
+  end
+
+  def color
+    "Red"
+  end
+
+  output :description, from: ->(item) { [item.name, item.color].join(', ') }
+end
+
+Item.new.output_attributes
+# => {:description=>"An Item, Red"}
+
+```
+
+You can of course just ignore it as well.
+
+```ruby
+class Item
+  include OutputAttributes
+
+  output :extracted_at, from: ->(_) { Time.now }
+end
+
+Item.new.output_attributes
+# => {:extracted_at=>2019-11-26 16:12:01 -0600}
+
+```
+
+I don't overwrite `#to_hash` or `#to_h` because I think those methods are kind of special. However, it's incredibly easy to do it yourself!
+
+```ruby
+class Item
+  include OutputAttributes
+  output def name
+    "An Item"
+  end
+
+  alias to_h output_attributes
+
+  # or
+
+  def to_hash
+    output_attributes.merge(
+      with: :more,
+      customization: :perhaps
+    )
+  end
+end
+
+item = Item.new
+# => #<Item:0x000055e0ae92d0a8>
+item.output_attributes
+# => {:name=>"An Item"}
+item.to_h
+# => {:name=>"An Item"}
+item.to_hash
+# => {:name=>"An Item", :with=>:more, :customization=>:perhaps}
+```
+
+I find this style particularly useful when working with Page Objects for data extraction:
+
+```ruby
+class Page < SimpleDelegator
+  include OutputAttributes
+
+  output def name
+    at_css('#title').text
+  end
+
+  output def price
+    at_css('.price').text
+  end
+
+  output def color
+    labels(:color)
+  end
+
+  output def size
+    labels(:size)
+  end
+
+  output :extracted_at, from: ->(_){ Time.now }
+
+  alias to_hash output_attributes
+
+  private
+  def labels(key)
+    at_css("li:contains('#{key}')").text
+  end
+
+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.
+
+
+# Fun Fact
+
+`def method; ...; end` returns a symbol. I saw a recent post on Reddit comparing Python's method decorators. This led to some example code using the Memoist gem that looked like this:
+
+```ruby
+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
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/output_attributes.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "output_attributes"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/output_attributes/version.rb

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

data/lib/output_attributes.rb

@@ -0,0 +1,89 @@
+require "output_attributes/version"
+
+# This module creates a class helper method `output` that can be used to create an output configuration
+# The goal is to help assemble a class's hash representation.
+# 
+# Each time you call `output` in the class definition, you register a key => proc pair.
+# You can then call `#output_attributes` to get the hash of key => values
+#
+# Example:
+#
+#    class Item
+#      include OutputAttributes
+#
+#      # You can register outputs similar to attr_accessors
+#      output :name
+#
+#      def name
+#        "A Thing"
+#      end
+#
+#      # Since the `def meth` expression returns a symbol, you can also register it like a decorator.
+#      # It returns the symbol so you could keep chaining with other similar tools like memoize
+#      output def price
+#        "free"
+#      end
+#
+#      # You can rename a method/key:
+#      output :cost, from: :price
+#
+#      # You can also define a custom proc if the key doesn't match a method name.
+#      # The argument to your proc is the instance itself so you have easy access to it's methods
+#      output :description, from: ->(item){ [item.name, item.price].join(': ') }
+#
+#      # You can also call whatever you want:
+#      output :extracted_at, from: ->(_){ Time.now }
+#
+#      def a_helper_method
+#        "Ignore this"
+#      end
+#
+#      # It does not override `#to_h/ash`, but this is easy enough if you wish!
+#      def to_h
+#        output_attributes
+#      end
+#      alias to_hash output_attributes
+#    end
+#
+#    item = Item.new
+#    item.output_attributes || item.to_h || item.to_hash
+#    # => 
+#      {
+#        name: "A Thing",
+#        price: "Free",
+#        description: "A Thing: Free",
+#        extracted_at: 2019-11-26 14:33:00.000
+#      }
+
+module OutputAttributes
+  # Register this class's catalog of outputs
+  def self.included(base)
+    base.class_eval do
+      @registered_output_attributes = {}
+
+      def self.output(key, from: nil)
+        @registered_output_attributes[key] = from || key
+        key
+      end
+
+      def self.registered_output_attributes
+        @registered_output_attributes
+      end
+    end
+  end
+
+  # Return a hash representing your outputs
+  def output_attributes
+    self.class.registered_output_attributes.map do |key, meth|
+      value = case meth
+      when Symbol, String
+        self.send(meth.to_sym)
+      when Proc
+        meth.call(self)
+      else
+        raise ArgumentError, "Could not determine how to output #{meth} for #{key}."
+      end
+      [key, value]
+    end.to_h
+  end
+end

data/output_attributes.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "output_attributes/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "output_attributes"
+  spec.version       = OutputAttributes::VERSION
+  spec.authors       = ["Tim Tilberg"]
+  spec.email         = ["ttilberg@gmail.com"]
+
+  spec.summary       = %q{Easily declare a hash to represent your object using `output` attributes}
+  spec.description   = <<~DESC
+    Sometimes defining #to_hash is a drag because the source location of your methods
+    is far away from `def to_hash`. This gem gives you a declarative way to build up
+    a hash representation of your object as you define your methods.
+  DESC
+  spec.homepage      = "https://www.github.com/ttilberg/output_attributes"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://www.github.com/ttilberg/output_attributes"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: output_attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Tilberg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: |
+  Sometimes defining #to_hash is a drag because the source location of your methods
+  is far away from `def to_hash`. This gem gives you a declarative way to build up
+  a hash representation of your object as you define your methods.
+email:
+- ttilberg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/output_attributes.rb
+- lib/output_attributes/version.rb
+- output_attributes.gemspec
+homepage: https://www.github.com/ttilberg/output_attributes
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://www.github.com/ttilberg/output_attributes
+  source_code_uri: https://www.github.com/ttilberg/output_attributes
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Easily declare a hash to represent your object using `output` attributes
+test_files: []