ishin 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fd416241ae632c771e85f2cbb4a8ecb151b6226
-  data.tar.gz: a2c3b7dccd9496fee3e790e58684bd782644e75f
+  metadata.gz: b5ed152cc96db8d638bde56aa627fc3fe4019038
+  data.tar.gz: 052b32431e70c55e0fe3497ca2e586ad86c031aa
 SHA512:
-  metadata.gz: a06fd4e613aab614d59d635369ab2b4b4be16ed6aadbe9dcae441a9515ec962d93a55a16a29ce5e36c4afb52f19cae90a1da3dbce58cb1af566bbb6035fe0f54
-  data.tar.gz: 5cff38f8588ed32d1b51eccafad2a97d7196983c406a365f8d2fff5ec1995bf44959020f54512fac1473aae05e9b735c47d0ff4aedb5cedf3110062fc1448850
+  metadata.gz: 087e9073b09d19c6001d386634165febbc9b9689343cdb00be535c3b2a0710b3862d3b8d79e7130efaa420e9c9fad4705c40f374ec50f09d406059428ef96f6c
+  data.tar.gz: aa5cb190539f3883c00b36204c8d4da0b19f66ed9c65dbb377aee7f50325dc20a5c2d022f7e838e09026a11a174f5f04cbf707084c3b1e37192328bcdd4c5318

data/.travis.yml

@@ -1,3 +1,5 @@
+script: "bundle exec rake"
 language: ruby
 rvm:
   - 2.2.0
+  - 2.2.2

data/README.md

@@ -1,3 +1,8 @@
+[![Code Climate](https://codeclimate.com/github/EddyLuten/ishin/badges/gpa.svg)](https://codeclimate.com/github/EddyLuten/ishin)
+[![Test Coverage](https://codeclimate.com/github/EddyLuten/ishin/badges/coverage.svg)](https://codeclimate.com/github/EddyLuten/ishin)
+[![Gem Version](https://img.shields.io/gem/v/ishin.svg)](https://rubygems.org/gems/ishin)
+[![Build Status](https://travis-ci.org/EddyLuten/ishin.svg?branch=master)](https://travis-ci.org/EddyLuten/ishin)
+
 # Ishin
 
 Ishin converts Ruby objects into their Hash representations. It works with plain old classes, extended classes, classes with mixins, and hashes (see Usage for more on that).
@@ -18,7 +23,9 @@ Or install it manually by:
 
     gem install ishin
 
-## Usage
+## Example
+
+As a class method callable on any object:
 
 ```ruby
 require 'ishin'
@@ -26,7 +33,19 @@ require 'ishin'
 hash = Ishin.to_hash(my_object)
 ```
 
-### Introduction
+Or included in your object as a mixin:
+
+```ruby
+class YourClass
+  include Ishin::Mixin
+  # etc.
+end
+
+instance = YourClass.new
+hash = instance.to_hash
+```
+
+### Usage
 
 A simple example is worth a thousand words:
 
@@ -110,6 +129,19 @@ Ishin.to_hash(lassie, symbolize: false)
 ```
 When setting the `symbolize` option to `false`, the explicit conversion of strings to symbols is prevented. This, however, does *not* mean that hashes whose keys are already symbols are converted into string-based keys.
 
+## As a Mixin
+
+To use Ishin as a mixin in your own objects, simply include `Ishin::Mixin`:
+
+```ruby
+class MyObject
+  include Ishin::Mixin
+  # etc.
+end
+```
+
+Your object now exposes a method named `to_hash` taking the same options at the `Ishin::to_hash` class method documented above.
+
 ## Running the Specs
 
 Once `bundle` is executed, simply run:

data/ishin.gemspec

@@ -20,8 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.8"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "codeclimate-test-reporter"
 end

data/lib/ishin.rb

@@ -2,6 +2,12 @@ require 'ishin/version'
 
 module Ishin
 
+  module Mixin
+    def to_hash options = {}
+      Ishin::to_hash(self, options)
+    end
+  end
+
   def self.to_hash(object, options = {})
     options = defaults.merge(options)
     result = {}

data/lib/ishin/version.rb

@@ -1,3 +1,3 @@
 module Ishin
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ishin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Eddy Luten
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-24 00:00:00.000000000 Z
+date: 2015-04-25 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-nc
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +67,6 @@ files:
 - README.md
 - Rakefile
 - bin/console
-- bin/setup
 - ishin.gemspec
 - lib/ishin.rb
 - lib/ishin/version.rb

data/bin/setup

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