lazy_as_json 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2089ff5725a076fc31c149b22365a0c661c517ba
+  data.tar.gz: 8c018d3b697b855eda8d922fa4fe8f83ba11dee0
+SHA512:
+  metadata.gz: 42a68a54d003a1863aff93dd434dca60b17c0390d4783e282a7d4a5309eb67934dd12b8807493d12dab3831a9c433035badb45bdf6f8f3af1af1d3eb7a5283de
+  data.tar.gz: 212626600b580f4ff5fbeb4e62f879c5fcf71094c9585434fcc72758824db30c9ed3108292f81d800c4c086ad8d523b00f8dc7e4e65cc84dc773e52b836a8500

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'bundler', '~> 1.11.2'
+
+# Specify your gem's dependencies in lazy_as_json.gemspec
+gemspec

data/README.md

@@ -0,0 +1,72 @@
+# LazyAsJson
+
+[![Circle CI](https://circleci.com/gh/we4tech/lazy-as-json.svg?style=svg)](https://circleci.com/gh/we4tech/lazy-as-json)
+
+A simple and concise way to use as_json with “only”, “except” and other options without using them literally.
+
+Instead of using this -
+
+`User.as_json(only: [:id, :first_name, profiles: [:company, :location]])`
+
+You can perhaps use this -
+
+`User.as_json(only_keys: ‘_,first_name,profiles(p),p.company,p.location’)`
+
+As simple as this.
+
+You can control what your API response should include through a flexible parameter string.
+
+i.e. - “/api/v1/users/me?_keys=_,last_name,profiles(p),p.company,p.location”
+
+This parameter string could dig through the nested objects and their nesting too.
+Just to reduce the API response size significantly, you can use this parameter control over wherever it is used.
+However it might seems quite trivial but frankly speaking it saves lot in response data hence faster loading time at client side.
+
+Moreover as it uses Hash.new and constructs attribute on runtime, you can throttle calling from the expensive method by using this parameter string.
+
+## How to Construct Attribute Filters ?
+
+|Symbol|Description|
+|---|---|
+|_|It represents id as short cut|
+|nested_objects(< name >)|It represents the alias for the nested object (it works with single or multiple values)|
+|< alias_name >.< key >|It represents the specific attribute from the nested object|
+|< alias_name >.< key >(< alias >)|It represents aliasing a nested object from a nested object and this list could go on and on.|
+
+### Example Usages
+
+```ruby
+User.as_json(only_keys: '_,first_name,email,profiles(p),p._,p.company,p.address(pa),pa.city,pa.country(pac),pac.iso_code')
+```
+
+Here, "_" represents `user_instance.id`, `profiles` represents `user_instance.profiles`, `p.address(pa)` represents `user_instance.profiles[].address` and finally `pa.country(pac)` represents `user_instance.profiles[].address.country` and so on.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lazy_as_json'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lazy_as_json
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lazy_as_json.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lazy_as_json"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

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

data/circle.yml

@@ -0,0 +1,8 @@
+machine:
+  ruby:
+    version: 2.2.1
+
+dependencies:
+  pre:
+    - if $(gem list bundler -v 1.9.5 -i); then gem uninstall -x -i /home/ubuntu/.rvm/gems/ruby-2.2.1@global bundler; fi
+    - gem install bundler -v "1.11.2"

data/lazy_as_json.gemspec

@@ -0,0 +1,55 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lazy_as_json/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lazy_as_json'
+  spec.version       = LazyAsJson::VERSION
+  spec.authors       = ['nhm tanveer hossain khan']
+  spec.email         = ['hasan83bd@gmail.com']
+
+  spec.summary       = %q{Take control on what to return from the API response, define the attributes map in a short syntax over parameter}
+  spec.description   = %q{Lazy As Json
+
+A simple and concise way to use as_json with “only”, “except” and other options without using them literally.
+
+Instead of using this -
+
+`User.as_json(only: [:id, :first_name, profiles: [:company, :location]])`
+
+You can perhaps use this -
+
+`User.as_json(only_keys: ‘_,first_name,profiles(p),p.company,p.location’)`
+
+As simple as this.
+
+You can control what your API response should include through a flexible parameter string.
+
+i.e. - “/api/v1/users/me?_keys=_,last_name,profiles(p),p.company,p.location”
+
+This parameter string could dig through the nested objects and their nesting too.
+Just to reduce the API response size significantly, you can use this parameter control over wherever it is used.
+However it might seems quite trivial but frankly speaking it saves lot in response data hence faster loading time at client side.
+
+Moreover as it uses Hash.new and constructs attribute on runtime, you can throttle calling from the expensive method by using this parameter string.
+}
+  spec.homepage      = 'http://hasan.wordpress.com'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/lazy_as_json.rb

@@ -0,0 +1,5 @@
+require 'lazy_as_json/version'
+
+module LazyAsJson ; end
+
+require 'lazy_as_json/attribute_filter'

data/lib/lazy_as_json/attribute_filter.rb

@@ -0,0 +1,160 @@
+module LazyAsJson
+  module AttributeFilter
+
+    def self.included(base)
+      base.respond_to?(:prepend) ?
+          base.prepend(OnlyKeysFilter) :
+          base.include(OnlyKeysFilter)
+    end
+
+    module OnlyKeysFilter
+      # The list of excluded attribute accessor name
+      BANNED_KEYS = [:all, :delete, :delete_all, :destroy_all, :destroy, :update, :save, :create,
+                     :create!, :save!, :update_attributes, :update_attribute, :update_attributes!,
+                     :find, :where, :increment, :increment!, :decrement, :decrement!, :remove,
+                     :object_id]
+
+      # Returns the JSON serializable hash object with the data from the specified keys.
+      #
+      # It Looks up for :only_keys for enabling attribute throttling, in case of absense it returns the
+      # actual data from overrode 'as_json' method.
+      #
+      # @param opts [Hash] The additional options whether to throttle response attribute or not.
+      # @return [Hash] The generated has based on the trottled keys or based on the overrode as_json method
+      def as_json(opts = {})
+        __set_only_keys opts.delete(:only_keys)
+
+        __lazy_mode? ? build_as_json : super(opts)
+      end
+
+      # Sets the only keys, if you intend to use those directly instead of going through :as_json
+      #
+      # @return key_str [String] The attribute filtering string
+      def __set_only_keys(key_str)
+        @__only_keys = key_str.to_s.strip
+        @__only_keys = @__only_keys.empty? ? nil : @__only_keys
+      end
+
+      # Returns the applied attribute filtering string
+      #
+      # @return [String] The attribute filtering string
+      def __only_keys
+        @__only_keys
+      end
+
+      # Creates a Hash object which lazly assembles attributes from the object or any of their parents.
+      # However, it could be delegated from another object through exposing :source method.
+      #
+      # @return [Hash] The empty Hash object with the attribute builder closure
+      def lazy_as_json(opts = {})
+        Hash.new do |hash, key|
+          hash[key] = _with_lazy(_find_value(key))
+        end
+      end
+
+      # Returns true if the lazy mode is enabled through :only_keys option
+      #
+      # @return [Boolean] true if lazy mode is enabled
+      def __lazy_mode?
+        __only_keys && !__only_keys.empty?
+      end
+
+      # Builds the attributes hash object based on the applied attribute filtering string
+      #
+      # @return [Hash] The attributes based on the attribute filtering string
+      def build_as_json
+        @_af_references = {}
+        hash            = lazy_as_json
+        keys            = []
+
+        __only_keys.split(',').each do |key|
+          value = hash
+
+          for nested_key in find_full_key(key)
+            if Array === value
+              value = value.map { |v| v[nested_key] }.compact
+            elsif Hash === value
+              value = value[nested_key]
+            end
+          end
+        end
+
+        hash
+      end
+
+      # Return true if the specified attribute key is not banned
+      #
+      # @return [Boolean] True if not listed under *BANNED_KEYS*
+      def __allowed_attribute_key?(key)
+        !BANNED_KEYS.include?(key)
+      end
+
+      private
+
+      def _with_lazy(value)
+        if value.respond_to?(:lazy_as_json)
+          value.lazy_as_json
+        elsif Array === value
+          value.map { |v| v.respond_to?(:lazy_as_json) ? v.lazy_as_json : v }
+        else
+          value
+        end
+      end
+
+      def _find_value(key)
+        return unless __allowed_attribute_key?(key)
+
+        if respond_to?(key)
+          send(key)
+        elsif _source_declared? && source.respond_to?(key)
+          source.send(key)
+        end
+      end
+
+      def _source_declared?
+        @_source_declared ||= respond_to?(:source)
+      end
+
+      # Generate a fully qualified key based on it's parent object reference tree based
+      # on the shortest key name.
+      #
+      def find_full_key(key)
+        # Try to find 'actual_name(alias)' key formation
+        if (matched = key.match(/^(.+)\((\w+)\)$/))
+          prefixes                    = matched[1].split('.')
+          @_af_references[matched[2]] =
+              (wrap_array(prefixes[0, prefixes.size - 1]).
+                  map { |prefix| @_af_references[prefix] } << prefixes.last.to_sym).
+                  flatten
+        else
+          # Split key string based on the '.'
+          parts    = key.split('.')
+
+          # Traverse through all prefixes and try to find if those are aliased or not aliased
+          # and build a complete reference tree.
+          prefixes = parts[0, parts.size - 1].map { |prefix| @_af_references[prefix] || [] }.flatten
+
+          # Take the actual key part
+          key_part = parts.last
+
+          # Construct the full reference tree and expand if short form is used.
+          suffix   = if key_part == '_'
+                       :id
+                     elsif (matched = key_part.match(/^(.+)_$/))
+                       :"#{matched[1]}_id"
+                     else
+                       key_part.to_sym
+                     end
+
+          prefixes << suffix
+        end
+      end
+
+      def wrap_array(values)
+        return [] if values.nil?
+        return values if Array === values
+        [values]
+      end
+    end
+  end
+end

data/lib/lazy_as_json/version.rb

@@ -0,0 +1,3 @@
+module LazyAsJson
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: lazy_as_json
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nhm tanveer hossain khan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |
+  Lazy As Json
+
+  A simple and concise way to use as_json with “only”, “except” and other options without using them literally.
+
+  Instead of using this -
+
+  `User.as_json(only: [:id, :first_name, profiles: [:company, :location]])`
+
+  You can perhaps use this -
+
+  `User.as_json(only_keys: ‘_,first_name,profiles(p),p.company,p.location’)`
+
+  As simple as this.
+
+  You can control what your API response should include through a flexible parameter string.
+
+  i.e. - “/api/v1/users/me?_keys=_,last_name,profiles(p),p.company,p.location”
+
+  This parameter string could dig through the nested objects and their nesting too.
+  Just to reduce the API response size significantly, you can use this parameter control over wherever it is used.
+  However it might seems quite trivial but frankly speaking it saves lot in response data hence faster loading time at client side.
+
+  Moreover as it uses Hash.new and constructs attribute on runtime, you can throttle calling from the expensive method by using this parameter string.
+email:
+- hasan83bd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lazy_as_json.gemspec
+- lib/lazy_as_json.rb
+- lib/lazy_as_json/attribute_filter.rb
+- lib/lazy_as_json/version.rb
+homepage: http://hasan.wordpress.com
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Take control on what to return from the API response, define the attributes
+  map in a short syntax over parameter
+test_files: []