hb 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a106e1faa458b8bcc191eee37a460eb213aabcf0
-  data.tar.gz: 6d66a47727e9660b65e0421657f43ea3a335b87a
+  metadata.gz: 99fe951457197fe94430c5e51ee5da6c806f92fa
+  data.tar.gz: a02ecba7c1057cf6b969373eaa0b144a772a9c82
 SHA512:
-  metadata.gz: 34a6c6c87c72fc5cc1a67ddb6d7f34dc049f999ff02631ca9b9c9134b4d477d07b781c4a96683450c66e87578bdfc89b192735a0346810c9675d54ad57d7b267
-  data.tar.gz: 44db5cf6552c5883bb69db3999ecb4b72d0a3cc89f4ad31836e406d752fb6d9afb69b36ac6fe69e03913eb9d03ecab897ebea5b6cd6866bfdd6cb2bb8c4bce24
+  metadata.gz: a3c08ca211f0668c940fa71376132c57d402dad43a155791c0e2ba20331851c2527284459d7cd5e275f7a5b7a7afcbee92fb2a78df51b6a20c0760f91c337653
+  data.tar.gz: f9aef9d829a71b88a476cb1e6254314018bf2ce6b7a2d34450201d835154a33228464b03856ed68317d7434e6001677b733f2d9fb10a63cc5eae81ba832b6aa5

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.ruby-version

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in hb.gemspec
 gemspec
+
+gem 'pry'

data/README.md

@@ -1,8 +1,6 @@
 # Hb
 
-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/hb`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Simple Hash Builder which has ActiveModelSerializers like interface.
 
 ## Installation
 
@@ -22,15 +20,66 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Creating Presenter
+Subclass Hb::Base and declare attributes.
+
+```ruby
+class PersonPresenter < Hb::Base
+  attributes :id, :email
+  attribute :last_name, key: :family_name
+end
+```
+The attributes names are whitelist of attributes to be exposed. You can change key name by using :key option.
+
+### Buildeing Hash
 
-## Development
+```ruby
+Person = Struct.new(:id, :email, :last_name, :first_name, :age)
+
+person = Person.new(1, 'shozawa@sample.com', 'shozawa', 'tomohiro', 28)
+
+PersonPresenter.new(person).to_h
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+# => { id: 1, email: 'shozawa@sample.com', family_name: 'shozawa' }
+
+# you can pass ActiveModel object like this
+PersonPresenter.new(User.find(1)).to_h
+```
 
-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).
+### Computed Attributes
+```ruby
+class PersonPresenter < Hb::Base
+  attributes :id, :email, :full_name
+  def full_name
+    "#{object.first_name} #{object.last_name}"
+  end
+end
+
+# => { id: 1, email: 'shozawa@sample.com', full_name: 'tomohiro shozawa' }
+```
+
+`object` is the object to be wrapped.
+
+### Transforming Keys
+```ruby
+# pass method_name
+Hb::Base.key_format :upcase
+PersonPresenter.new(person).to_h
+# => { "ID" => 1, "EMAIL" => 'shozawa@sample.com', "FULL_NAME": ... }
+
+# with options
+Hb::Base.key_format camelize: :lower
+PersonPresenter.new(person).to_h
+# => { "id" => 1, "email" => 'shozawa@sample.com', "fullName": ... }
+
+# you can pass proc
+Hb::Base.key_format -> (k) { '_' + k }
+PersonPresenter.new(person).to_h
+# => { "_id" => 1, "_email" => 'shozawa@sample.com', "_full_name": ... }
+
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hb.
+Bug reports and pull requests are welcome on GitHub at https://github.com/shozawa/hb.
 

data/Rakefile

@@ -1,2 +1,10 @@
 require "bundler/gem_tasks"
-task :default => :spec
+require "rake/testtask"
+
+Rake::TestTask.new do |test|
+  test.libs << 'test'
+  test.test_files = FileList[ 'test/**/*_test.rb' ]
+  test.verbose = true
+end
+
+task :default => [:test]

data/bin/console

@@ -6,9 +6,5 @@ require "hb"
 # 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
-
-require "irb"
-IRB.start
+require "pry"
+Pry.start

data/lib/hb/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - shozawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-14 00:00:00.000000000 Z
+date: 2017-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,7 +60,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".ruby-version"
 - Gemfile
 - README.md
 - Rakefile

data/.ruby-version

@@ -1 +0,0 @@
-2.3.3