json-encodable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0bf6e0b66a6b91365aff2c33598588fc9df00621
+  data.tar.gz: 6e03c6710630f90087ce06833076906479f46c0e
+SHA512:
+  metadata.gz: 63b4ac30bc4d8e1c3cb19455606bc7864caac4268e1198c51377f23a652b6f020d20c6efa038fc05fb8d3c9ad6d037b851bb349a369d944ac04af484be7d8eea
+  data.tar.gz: 6e7370ac9f1b573969f0fc6e666d9cd5b1649c7996c05e2ec9cba18d5b47fe428e8433ead737997be79711ecf732732e0e399334795c8f7f18b9eb0fe57b85b9

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryo Nakamura
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# JSON::Encodable
+Make a class encodable into JSON format.
+
+## Usage
+1. Include `JSON::Encodable` module
+2. Call `.property` method with property name
+3. Then the instance will be able to respond to `.to_json` method
+
+### #to_json
+```ruby
+class Blog
+  include JSON::Encodable
+
+  property :id
+  property :title
+  property :username
+
+  def id
+    1
+  end
+
+  def title
+    "wonderland"
+  end
+
+  def username
+    "alice"
+  end
+end
+
+Blog.new.to_json
+#=> '{"id":1,"title":"wonderland","username":"alice"}'
+```
+
+### #as_json(options = {})
+You can also call `.as_json` method with `:except` and `:only` options.
+
+```ruby
+Blog.new.as_json(only: [:id, :username])
+#=> {"id":1,"username":"alice"}
+
+Blog.new.as_json(except: [:username])
+#=> {"id":1,"title":"wonderland"}
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/json-encodable.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "json/encodable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "json-encodable"
+  spec.version       = JSON::Encodable::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+  spec.summary       = "Make a class encodable into JSON format."
+  spec.homepage      = "https://github.com/r7kamura/json-encodable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "2.14.1"
+  spec.add_development_dependency "rspec-json_matcher"
+end

data/lib/json-encodable.rb

@@ -0,0 +1 @@
+require "json_encoder/encodable"

data/lib/json/encodable.rb

@@ -0,0 +1,108 @@
+require "active_support/concern"
+require "active_support/core_ext/hash/reverse_merge"
+require "active_support/core_ext/object/json"
+require "active_support/core_ext/string/inflections"
+require "active_support/json"
+
+require "json/encodable/version"
+
+# Makes an included module encodable into JSON format by putting .as_json method.
+#
+# @example
+#   class Blog
+#     include JSON::Encodable
+#
+#     property :id
+#     property :title
+#     property :username
+#
+#     def id
+#       1
+#     end
+#
+#     def title
+#       "wonderland"
+#     end
+#
+#     def username
+#       "alice"
+#     end
+#   end
+#
+#   puts Blog.new.to_json
+#   #=> {"id":1,"title":"wonderland","username":"alice"}
+#
+# You can pass :only and :except options to .to_json method.
+#
+# @example
+#   puts Blog.new.to_json(only: [:id, :username])
+#   #=> {"id":1,"username":"alice"}
+#
+#   puts Blog.new.to_json(except: [:username])
+#   #=> {"id":1,"title":"wonderland"}
+#
+module JSON
+  module Encodable
+    extend ActiveSupport::Concern
+
+    # @return [Hash] An object representation of its properties.
+    # @example
+    #   {
+    #     id: 1,
+    #     title: "wonderland",
+    #     username: "alice",
+    #   }
+    def as_json(options = {})
+      properties(options).as_json(options)
+    end
+
+    private
+
+    # @note All Time values will be encoded in ISO 8601 format
+    # @param options [Hash] Options for .property_names method
+    # @option options [Array<Symbol>] :except Property names to exclude properties
+    # @option options [Array<Symbol>] :only Property names to filter properties
+    # @return [Hash{Symbol => Object}] Properties as a key-value pairs Hash
+    # @example
+    #   {
+    #     id: 1,
+    #     title: "wonderland",
+    #     username: "alice",
+    #     created_at: "2014-07-11T11:28:54+09:00",
+    #   }
+    def properties(options = {})
+      names = self.class.property_names
+      names = names - options[:except] if options[:except]
+      names = names & options[:only] if options[:only]
+      names.inject({}) do |hash, property_name|
+        key = property_name
+        value = send(property_name)
+        value = value.iso8601 if value.is_a?(Time)
+        hash.merge(key => value)
+      end
+    end
+
+    module ClassMethods
+      attr_writer :property_names
+
+      # Stores property names, used to build JSON properties
+      # @return [Array]
+      def property_names
+        @property_names ||= []
+      end
+
+      # Defines a given property name as a property of the JSON prepresentation its class
+      # @param normal_property_name [Symbol]
+      def property(property_name)
+        property_names << property_name
+      end
+
+      # Inherits property_names, while they are not shared between a parent and their children
+      # @note Override
+      def inherited(child)
+        super
+        child.property_names = property_names.clone
+      end
+    end
+  end
+end

data/lib/json/encodable/version.rb

@@ -0,0 +1,5 @@
+module JSON
+  module Encodable
+    VERSION = "0.0.1"
+  end
+end

data/spec/json/encodable_spec.rb

@@ -0,0 +1,78 @@
+require "spec_helper"
+
+describe JSON::Encodable do
+  subject do
+    instance.to_json(options)
+  end
+
+  let(:klass) do
+    Class.new do
+      include JSON::Encodable
+
+      property :id
+      property :title
+      property :username
+
+      # Dummy name to prevent defining a class in the global namespace
+      def self.name
+        "Foo::BarBaz"
+      end
+
+      def id
+        1
+      end
+
+      def title
+        "wonderland"
+      end
+
+      def username
+        "alice"
+      end
+    end
+  end
+
+  let(:options) do
+    {}
+  end
+
+  let(:instance) do
+    klass.new
+  end
+
+  describe ".to_json" do
+    context "without any options" do
+      it "returns an Object in JSON format" do
+        should be_json_as(
+          id: 1,
+          title: "wonderland",
+          username: "alice",
+        )
+      end
+    end
+
+    context "with :except option" do
+      before do
+        options[:except] = [:id]
+      end
+
+      it "excludes those properties" do
+        instance.should_not_receive(:id)
+        should be_json_as(
+          title: "wonderland",
+          username: "alice",
+        )
+      end
+    end
+
+    context "with :only option" do
+      before do
+        options[:only] = [:id]
+      end
+
+      it "excludes those properties" do
+        should be_json_as(id: 1)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require "json/encodable"
+require "rspec/json_matcher"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.include RSpec::JsonMatcher
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: json-encodable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: rspec-json_matcher
+  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: 
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- json-encodable.gemspec
+- lib/json-encodable.rb
+- lib/json/encodable.rb
+- lib/json/encodable/version.rb
+- spec/json/encodable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/r7kamura/json-encodable
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Make a class encodable into JSON format.
+test_files:
+- spec/json/encodable_spec.rb
+- spec/spec_helper.rb
+has_rdoc: