field_serializer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34436e5d82ef706f2d601e9df2909cd4426b95a6
-  data.tar.gz: 9791296a88be87f456c2dc03bb653c92173e1602
+  metadata.gz: 35c67edd67d4a77fb624b6164547b59efaf1440c
+  data.tar.gz: 03034a9b2bd6fb821f320b80e1e23a3accf54f80
 SHA512:
-  metadata.gz: afaa5f15275c4126db71bf52c018241e3f0886fb83948878f8cfe83214f459f27bc6dd3dcdc3311dc013a29c5e9091ac78b4fab03b6065f30f28e66b4838d562
-  data.tar.gz: 93189278e1cdd21b98e147f10953710daa6df15a2f30357c7aedd2dcce5eceed5d981ee54e10f8296aeef2f35cbda73cdfc9e59c9ebb925c53a3349a21729fea
+  metadata.gz: 1ae654bf02b7be05ed4d201898af6acb1159d97a161aed04812108910958cd2d98574b3dc1dfb7aebebcf14443c57dbe0bfbc6c71925e3bc3b9d862349f9e9a1
+  data.tar.gz: 6386530c79cf4ea076a9758672b8f94931dfff07b6f0e6c3696745381cad021eec2222eff37cea0c788b07c34a552570ca4e4ad0b9188cdf1f95238f8edcecc0

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.3.0](https://github.com/everypolitician/field_serializer/compare/v0.2.0...v0.3.0) - 2016-12-02
+
+### Added
+
+- There is now a proper README with some basic documentation.
+
+### Fixed
+
+- Inheritance now works as expected. Previously subclasses weren't getting the
+  fields from the parent class. [#7](https://github.com/everypolitician/field_serializer/pull/7).
+
+## [0.2.0](https://github.com/everypolitician/field_serializer/compare/v0.1.0...v0.2.0) - 2016-10-28
+
+### Changed
+
+- There is now a hard requirement for Ruby >= 2.1. This is because we're using
+  required keyword arguments, which were introduced in Ruby 2.1.
+- Fields are now defined as methods behind the scenes. This means you can call
+  them like normal methods from other fields.
+
+## 0.1.0 - 2016-09-28
+
+- Initial release

data/README.md

@@ -1,8 +1,10 @@
 # FieldSerializer
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/field_serializer`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Ruby module which allows you to specify a set of fields that you'd like
+serialized in the `#to_h` method. We ([EveryPolitician](http://everypolitician.org/))
+are using this library in our scrapers to make them more declarative. It allows
+us to specify which fields we'd like to be scraped from a page without coupling
+ourselves to how the page is fetched or where the data ends up being stored.
 
 ## Installation
 
@@ -22,7 +24,24 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'field_serializer'
+
+class Person
+  include FieldSerializer
+
+  field :name do
+    'Alice'
+  end
+
+  field :fruit do
+    :apple
+  end
+end
+
+puts Person.new.to_h
+# => { :name => "Alice", :fruit => :apple }
+```
 
 ## Development
 
@@ -32,5 +51,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/field_serializer.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/everypolitician/field_serializer.

data/lib/field_serializer.rb

@@ -5,11 +5,10 @@ module FieldSerializer
     klass.extend(ClassMethods)
   end
 
-  def initialize(options = {})
-    options.each { |o, v| define_singleton_method(o) { v } }
-  end
-
   module ClassMethods
+    def inherited(subclass)
+      subclass.fields.concat(fields)
+    end
 
     def fields
       @fields ||= []

data/lib/field_serializer/version.rb

@@ -1,3 +1,3 @@
 module FieldSerializer
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: field_serializer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - EveryPolitician team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-28 00:00:00.000000000 Z
+date: 2016-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,6 +62,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -91,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Define a set of fields and serialize them to a hash.