json-encodable 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60320d82f60c457b9360b943d1c73cff3fc4b61e
-  data.tar.gz: 32bac5f41d30df13ccd1f24b00f0738a6b2e81d5
+  metadata.gz: e414ac50d8cfab870205ef14aa3bb3447f6919dd
+  data.tar.gz: 5b6924e2bb5fb84dde7e40ff53493b5605c6bbbf
 SHA512:
-  metadata.gz: d21247643d7c2f7d70ff302b131f626b7061b71644988f440a1704a45942ad2969021a07486be2f432470af884ef97f557aaf293b6f2b8e37a981ce81ad0ec77
-  data.tar.gz: 913b8affcdd2804cba377121934e3731c28106db44206f184af28c3d09e172e35f2e7c50f2d2ef856f9b6f7980f9fc8857171541d4d7f4042af8f3443befb58e
+  metadata.gz: ade9a952eb1a3948f38adc341512917908bbf91ee484a1f90e387c3b9e07e3dc906f50fca4eadf7ee2f707d900dce43cc3fe86db2fe5102b5507eaf65ad0b997
+  data.tar.gz: 59296009778e8aec1c8d7f6f16b33e608c747a1070ba7b74ee32fb519048d2e86c94f7b2647a248f1e285121dd0d01c5b74e7e25f732edf679f2cd662f409c9b

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.1.0
+- Support optional metadata on each property
+
 ## 0.0.3
 - Support non-Array arguments in :except and only option (thx @yujinakayama)
 

data/README.md

@@ -42,3 +42,21 @@ Blog.new.as_json(only: [:id, :username])
 Blog.new.as_json(except: :username)
 #=> { "id" => 1, "title" => "wonderland" }
 ```
+
+## Advanced
+You can contain any optional meta-information on each properties,
+and access to them by `.properties` method.
+
+```rb
+class Blog
+  include JSON::Encodable
+
+  property :id, type: Integer
+  property :title, type: String
+  property :username, type: String
+end
+
+# Returns an array of `JSON::Encodable::Property` instances.
+# Each instance has `#name` and `#options` methods.
+Blog.properties
+```

data/json-encodable.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |spec|
   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", "3.2.0"
   spec.add_development_dependency "rspec-json_matcher"
 end

data/lib/json/encodable.rb

@@ -1,7 +1,7 @@
 require "active_support/concern"
 require "active_support/core_ext/object/json"
 require "active_support/json"
-
+require "json/encodable/property"
 require "json/encodable/version"
 
 # Makes an included module encodable into JSON format by putting .as_json method.
@@ -83,23 +83,25 @@ module JSON
     module ClassMethods
       attr_writer :property_names
 
-      # Stores property names, used to build JSON properties
-      # @return [Array]
+      # @return [Array<Symbol>]
       def property_names
-        @property_names ||= []
+        properties.map(&:name)
+      end
+
+      # @return [Array<JSON::Encodable::Property>]
+      def properties
+        @properies ||= []
       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
+      # @param [Symbol] property_name
+      def property(property_name, options = {})
+        properties << ::JSON::Encodable::Property.new(property_name, options)
       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
+        child.properties = properties.clone
       end
     end
   end

data/lib/json/encodable/property.rb

@@ -0,0 +1,18 @@
+module JSON
+  module Encodable
+    class Property
+      # @return [Symbol]
+      attr_reader :name
+
+      # @return [Hash{Symbol => Object}]
+      attr_reader :options
+
+      # @param [Symbol] name
+      # @param [Hash{Symbol => Object}] options
+      def initialize(name, options = {})
+        @name = name
+        @options = options
+      end
+    end
+  end
+end

data/lib/json/encodable/version.rb

@@ -1,5 +1,5 @@
 module JSON
   module Encodable
-    VERSION = "0.0.3"
+    VERSION = "0.1.0"
   end
 end

data/spec/json/encodable_spec.rb

@@ -9,9 +9,9 @@ describe JSON::Encodable do
     Class.new do
       include JSON::Encodable
 
-      property :id
-      property :title
-      property :username
+      property :id, type: Integer
+      property :title, type: String
+      property :username, type: String
 
       # Dummy name to prevent defining a class in the global namespace
       def self.name
@@ -40,7 +40,25 @@ describe JSON::Encodable do
     klass.new
   end
 
-  describe ".to_json" do
+  describe ".properties" do
+    subject do
+      klass.properties
+    end
+
+    it "returns an Array of JSON::Encodable::Property objects" do
+      should match(
+        array_including(
+          [
+            instance_of(JSON::Encodable::Property),
+            instance_of(JSON::Encodable::Property),
+            instance_of(JSON::Encodable::Property),
+          ],
+        ),
+      )
+    end
+  end
+
+  describe "#to_json" do
     context "without any options" do
       it "returns an Object in JSON format" do
         should be_json_as(

data/spec/spec_helper.rb

@@ -2,7 +2,6 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json-encodable
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-23 00:00:00.000000000 Z
+date: 2015-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: rspec-json_matcher
   requirement: !ruby/object:Gem::Requirement
@@ -96,6 +96,7 @@ files:
 - json-encodable.gemspec
 - lib/json-encodable.rb
 - lib/json/encodable.rb
+- lib/json/encodable/property.rb
 - lib/json/encodable/version.rb
 - spec/json/encodable_spec.rb
 - spec/spec_helper.rb
@@ -126,4 +127,3 @@ summary: Make a class encodable into JSON format.
 test_files:
 - spec/json/encodable_spec.rb
 - spec/spec_helper.rb
-has_rdoc: