active_model_as_json_filter 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 David Chen
+
+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.markdown

@@ -0,0 +1,46 @@
+active_model_as_json_filter
+===========================
+直接通过配置属性来生成as_json。
+
+
+说明
+---------------------------
+不要直接覆写as_json，否则分配在多个文件的model的json会混乱，不知道谁改写了谁。
+
+改用ActiveModel::AsJsonFilter可以直接通过配置属性来生成as_json。
+
+示例
+---------------------------
+
+```ruby
+class App
+  self.as_json_options.except.add(:classroom_ids)
+end
+```
+
+* 配置as_json参数
+
+Model的属性 ExampleModel.as_json_options 均可以通过 as_json 本身支持的 only,
+except, methods 来 add 附加字段，如果不设置，就和 as_json 默认行为一样。
+
+* 配置全局和局部回调, 该功能解决了完全自定义的问题。
+
+1. 可以在全局层面配置:
+
+```ruby
+ActiveModel::AsJsonFilter.finalizer_proc = lambda do |result|
+ result['id'] = result['uuid'] if result['uuid']
+ return result
+end
+```
+
+2. 也可以在局部层面配置
+
+```ruby
+ExampleModel.as_json_options.finalizer_proc = lambda do |result, item|
+  result['download_url'] = item.current_version.download_url
+  return result
+end
+```
+
+3. 两者都在as_json最后调用，并且局部会覆盖全局。

data/active_model_as_json_filter.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name        = 'active_model_as_json_filter'
+  s.version     = '0.0.1'
+  s.date        = '2013-12-05'
+  s.summary     = File.read("README.markdown").split(/===+/)[1].strip.split("\n")[0]
+  s.description = s.summary
+  s.authors     = ["David Chen"]
+  s.email       = 'mvjome@gmail.com'
+  s.homepage    = 'https://github.com/SunshineLibrary/active_model_as_json_filter/'
+  s.license     = 'MIT'
+
+  s.add_dependency "mongoid"
+  s.add_dependency "activesupport", "> 3.2"
+
+  s.files = `git ls-files`.split("\n")
+end

data/lib/active_model_as_json_filter.rb

@@ -0,0 +1,76 @@
+# encoding: UTF-8
+
+module ::ActiveModel
+  module AsJsonFilter
+
+    extend ActiveSupport::Concern
+
+    # 默认公共字段配置
+    #
+    # 以下是个属性在配置时直接覆盖即可。
+    OptionMethods = [:default_only_fields, :default_except_fields, :default_methods_fields]
+    mattr_accessor(*OptionMethods)
+
+    mattr_accessor :finalizer_proc
+    if not self.finalizer_proc # 避免重载时覆盖
+      self.finalizer_proc = lambda {|hash| return hash } 
+    end
+
+    # 封装 as_json 参数
+    class AsJsonOptions
+      OptionFields = [:only, :except, :methods]
+      attr_reader(*OptionFields)
+
+      # 不要使用方法污染了方法空间。
+      #
+      # 比如: 可以在这里返回 键id 为别的非主键的值，以应对客户端刁难的需求。
+      # self.as_json_options.finalizer_proc = lambda do |result, item|
+      #   result['id']        = item.uuid.hash % 2**31
+      #   return result
+      # end
+      attr_accessor :finalizer_proc
+
+      class SetWithMultiplePush < Set
+        undef :add
+        def add *args
+          Array(args).flatten.compact.each {|i| self << i }
+        end
+      end
+
+      def initialize
+        @only, @except, @methods = SetWithMultiplePush.new, SetWithMultiplePush.new, SetWithMultiplePush.new
+        @finalizer_proc = lambda {|hash, item = nil| return hash.merge(Hash.new) }
+      end
+    end
+
+    included do
+      cattr_reader :as_json_options
+      self.class_variable_set "@@as_json_options", AsJsonOptions.new
+
+      # 输入配置字段
+      OptionMethods.each do |fields|
+        reader = fields.to_s.split('_')[1]
+        Array(ActiveModel::AsJsonFilter.send(fields)).flatten.compact.each do |v|
+          self.as_json_options.send(reader).add v if not self.as_json_options.send(reader).include? v
+        end
+      end
+    end
+
+    # InstanceMethods
+    def as_json options = {}
+      # 1. 配置参数
+      _o = {}
+      AsJsonOptions::OptionFields.each do |field|
+        _v = Array(self.class.as_json_options.send(field)).flatten.to_a.map(&:to_sym)
+        _o[field] = _v if not _v.empty?
+      end
+      result = super _o.merge(options)
+      # 2. 两次全局和局部回调
+      result = ActiveModel::AsJsonFilter.finalizer_proc.call(result)
+      result = self.class.as_json_options.finalizer_proc.call(result, self)
+
+      return result
+    end
+
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: active_model_as_json_filter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: 直接通过配置属性来生成as_json。
+email: mvjome@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE
+- README.markdown
+- active_model_as_json_filter.gemspec
+- lib/active_model_as_json_filter.rb
+homepage: https://github.com/SunshineLibrary/active_model_as_json_filter/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: 直接通过配置属性来生成as_json。
+test_files: []