json_serializable 0.0.2 → 0.1.0

data/.gitignore

@@ -1,4 +1,3 @@
 *.gem
 .bundle
-Gemfile.lock
 pkg/*

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -1,4 +1,6 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in json_serializable.gemspec
 gemspec
+
+gem "rake"
+gem "rspec"

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    json_serializable (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rake (0.9.2.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  json_serializable!
+  rake
+  rspec

data/Rakefile

@@ -1 +1,11 @@
+require "bundler"
 require "bundler/gem_tasks"
+Bundler.setup
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec") do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec

data/lib/json_serializable.rb

@@ -1,6 +1,13 @@
-# json_serializable [:name, :description],
-#       :price => lambda{|content| content.price.to_i},
-#       :secret_key => :primary_key
+# This Module extends the as_json method in your model to easily customize the JSON output
+#
+# Example:
+# include JsonSerializable
+# json_serializable [:name, :description], :private => lambda {|model| model.secret}
+# this will produce the following Hash
+# {:name => model.name, :description => model.description, :private => model.secret}
+#
+# This module works best when you want to whitelist your attributes for JSON and want to
+# use different names/values than your attributes name in the models
 
 require "json_serializable/version"
 
@@ -15,11 +22,15 @@ module JsonSerializable
 
     def as_json(options = {})
       options ||= {}
-      custom_options = self.class.json_field_names.present? ? options.merge(only: self.class.json_field_names) : options
+      custom_options = self.class.json_field_names.size > 0 ? options.merge(only: self.class.json_field_names) : options
       custom_hash = super(custom_options)
 
       self.class.json_mappings.each_pair do |key, value|
-        custom_hash[key] = value.is_a?(Symbol) ? self.send(value) : value[self]
+        if value.is_a?(Symbol)
+           custom_hash[value] = self.send(key)
+        else
+           custom_hash[key] = value[self]
+        end
       end
 
       custom_hash
@@ -28,6 +39,7 @@ module JsonSerializable
 
   module ClassMethods
 
+
     def json_serializable field_names, mappings = {}
       @@json_field_names = field_names
       @@json_mappings = mappings
@@ -38,7 +50,7 @@ module JsonSerializable
     end
 
     def json_mappings
-      @@json_mappings ||= []
+      @@json_mappings ||= {}
     end
 
   end

data/lib/json_serializable/version.rb

@@ -1,3 +1,3 @@
 module JsonSerializable
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/json_serializable_spec.rb

@@ -0,0 +1,69 @@
+require 'json_serializable'
+
+class Base
+  def as_json(options = {})
+    options
+  end
+end
+
+class Model < Base
+  include JsonSerializable
+
+  attr_accessor :name, :description, :secret
+
+  def greet
+    "Hello there"
+  end
+end
+
+describe JsonSerializable do
+
+  before(:each) do
+    @model = Model.new
+  end
+
+  it 'should use base.as_json by default' do
+    @model.as_json(hello: "world").should == {hello: "world"}
+  end
+
+  describe 'custom serialization' do
+
+    before(:each) do
+      @model.name = "Sohan"
+      @model.description = "Simple guy"
+      @model.secret = "8789aasd7"
+    end
+
+    it 'should whitelist the fields' do
+      Model.class_eval do
+        json_serializable [:name, :description]
+      end
+
+      @model.as_json.should == {only: [:name, :description]}
+    end
+
+    it 'should whitelist with lambdas' do
+      Model.class_eval do
+        json_serializable [:name], :private => lambda {|model| model.secret}
+      end
+
+      @model.as_json.should == {only: [:name], :private => @model.secret}
+    end
+
+    it 'should allow methods with custom key' do
+      Model.class_eval do
+        json_serializable [:name], :greet => :welcome
+      end
+
+      @model.as_json.should == {only: [:name], :welcome => "Hello there"}
+    end
+
+    it 'should allow fields with custom key' do
+      Model.class_eval do
+        json_serializable [:name], :description => :summary
+      end
+
+      @model.as_json.should == {only: [:name], :summary => "Simple guy"}
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_serializable
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2164770400 !ruby/object:Gem::Requirement
+  requirement: &2156365720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164770400
+  version_requirements: *2156365720
 description: Use custom names in JSON keys and your custom logic in JSON values
 email:
 - sohan39@gmail.com
@@ -30,11 +30,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
+- Gemfile.lock
 - Rakefile
 - json_serializable.gemspec
 - lib/json_serializable.rb
 - lib/json_serializable/version.rb
+- spec/json_serializable_spec.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -47,16 +50,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 329497193356031779
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 329497193356031779
 requirements: []
 rubyforge_project: json_serializable
-rubygems_version: 1.8.11
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Provides a clean approach to custom JSON serialize your AR models
-test_files: []
+test_files:
+- spec/json_serializable_spec.rb