builder_support 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c78dfde8fe983ec67e339c3f313f13acac132f1b21bd80994491113889b02176
+  data.tar.gz: 2d2078e3cff3f8143a82f080a1fa11510edf5bb9397a2d357ccd36f85706ae1e
+SHA512:
+  metadata.gz: 82b46753c4361a475751c9dcc88bbe327708dbe5e7a7bf03ec8a617af36ed062d897ecbbfcbb2349996fc588715e3e2fa5663e32121cf9d30900c00770603e23
+  data.tar.gz: e52166d2700ef6a0fb80de30c6bcd7b6f30e2b0176c601697c2a6a64291a5bcdb740f9461e5cba0680b5e937c014bfe248c10966559dccaa4cfd4321c5972b5c

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at x@skippingcat.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in builder_support.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    builder_support (1.0.0)
+      activerecord (>= 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.5)
+      activesupport (= 5.1.5)
+    activerecord (5.1.5)
+      activemodel (= 5.1.5)
+      activesupport (= 5.1.5)
+      arel (~> 8.0)
+    activesupport (5.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    docile (1.3.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  builder_support!
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 zhandao
+
+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,92 @@
+# BuilderSupport
+
+Provide a very simple way to transform ActiveRecord data into JSON output based on JBuilder.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'builder_support'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install builder_support
+
+## Usage
+
+Suppose the table `users`:
+```ruby
+t.string :name,            null: false
+t.string :password_digest, null: false
+t.string :email
+```
+
+Model:
+```ruby
+class User
+  include BuilderSupport
+  # YES, all you have to do is write this line
+  builder_support rmv: %i[ password_digest ]
+end
+```
+
+Console:
+```
+  $ User.all.to_builder # on records (active relation)
+ => [
+        { "id" => 1, "name" => "zhandao", "email" => "xxxx" },
+        { "id" => 2, "name" => "ikkiuchi", "email" => "xxxx" }
+    ]
+  $ User.last.to_builder # on a record
+ => { "id" => 2, "name" => "ikkiuchi", "email" => "xxxx" }
+```
+
+Explain:
+
+1. Basic principle: the supporter know all the fields name through `column_names` (a db mapping func),
+    so you just have to declare which fields do not need to output by passing 'rvm' param.
+2. You can also `add` something to the output JSON, but make sure that the field name you add needs to correspond to the model instance methods.  
+    The following example will generate `{ ..., "addtion_field" => "value' }`
+    ```ruby
+    class User
+      builder_support add: :addition_field
+      
+      def addition_field
+        'value'
+      end
+    end
+    ```
+
+## Advanced Usage
+
+TODO
+
+```ruby
+builder_add :sub_categories_info, when: :get_nested_list
+builder_add :base_category_info, name: :base_category, when: -> { base_category.present? }
+builder_map a: :b
+```
+
+## 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]/builder_support. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the BuilderSupport project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/builder_support/blob/master/CODE_OF_CONDUCT.md).

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 "builder_support"
+
+# 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(__FILE__)

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/builder_support.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'builder_support/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'builder_support'
+  spec.version       = BuilderSupport::VERSION
+  spec.authors       = ['zhandao']
+  spec.email         = ['x@skippingcat.com']
+
+  spec.summary       = 'Provide a very simple way to transform ActiveRecord data into JSON output based on JBuilder.'
+  spec.description   = 'Provide a very simple way to transform ActiveRecord data into JSON output based on JBuilder.'
+  spec.homepage      = 'https://github.com/ikkiuchi/builder_support'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov'
+
+  spec.add_runtime_dependency 'activerecord', '>= 3'
+end

data/lib/builder_support.rb

@@ -0,0 +1,119 @@
+require 'builder_support/version'
+
+module BuilderSupport
+  def self.included(base)
+    base.class_eval do
+      def self.builder_support rmv: [ ], add: [ ]
+        extend ClassMethods
+        delegate :show_attrs, :flatten_attrs, to: self
+        include InstanceMethods
+
+        builder_rmv *rmv
+        # %i[ a, b, c d ]
+        # %i[ flatten: a b, other_declare: c d ]
+        # 'a b and c'
+        # 'flatten: a and b, other_declare: c and d'
+        add = add.split(/ and | /) if add.is_a? String
+        add.map { |item| item[','] ? [item.to_s.delete(','), ','] : item }
+            .flatten.map(&:to_sym).split(:',').each do |attrs|
+          builder_add *attrs
+        end
+      end
+    end
+  end
+
+  module InstanceMethods
+    def to_builder(rmv: [ ], add: [ ], merge: { }, flt_add: [ ], flt_rmv: [ ])
+      res = Jbuilder.new do |json|
+        dynamic_attrs = self.class.instance_variable_get(:@builder_add_dynamically)
+        dynamic_attrs&.each { |attr, proc| add << attr if instance_exec(&proc) }
+        json.(self, *self.show_attrs(rmv: rmv, add: add))
+
+        self.flatten_attrs(rmv: flt_rmv, add: flt_add).each do |flatten_attr|
+          json.merge! flatten_attr => self.send(flatten_attr)
+        end
+        instance_exec(json, &json_addition)
+        json.merge! merge
+      end.attributes!
+
+      mapping = self.class.instance_variable_get(:@builder_map) || { }
+      res.transform_keys! { |key| (mapping[key.to_sym] || key).to_s }
+    end
+
+    def json_addition
+      proc { }
+    end
+  end
+
+  module ClassMethods
+    # FIXME: 很奇怪的 scope 影响，尽量用转成 arr 的 to_bd 而不是直接调
+    def to_builder(rmv: [ ], add: [ ], merge: { })
+      all.to_a.to_builder(rmv: rmv, add: add, merge: merge)
+    end
+
+    def builder_rmv *attrs
+      (@builder_rmv ||= [ ]).concat attrs
+    end
+
+    def builder_add *attrs, when: nil, name: nil, &block
+      define_method(attrs.first) { instance_eval(&block) } if block_given?
+      builder_map attrs[0] => name if name
+
+      if (w = binding.local_variable_get(:when))
+        builder_add_with_when attrs[0], when: w
+      elsif attrs.delete(:flatten)
+        (@flatten_attrs ||= [ ]).concat attrs
+      else
+        (@builder_add ||= [ ]).concat attrs
+        generate_assoc_info_method attrs
+      end
+    end
+
+    def builder_map settings = { }
+      (@builder_map ||= { }).merge! settings
+    end
+
+    def show_attrs(rmv: [ ], add: [ ])
+      self.column_names.map(&:to_sym) \
+          - (@builder_rmv || [ ]) - rmv \
+          + (@builder_add || [ ]) + add
+    end
+
+    def flatten_attrs(rmv: [ ], add: [ ])
+      (@flatten_attrs ||= [ ]) - rmv + add
+    end
+
+    def builder_add_with_when(attr, when:)
+      w = binding.local_variable_get(:when)
+      # 生成 when 设置的同名函数
+      # 用以设置状态
+      if w.is_a? Symbol
+        define_singleton_method w do
+          all.to_a.to_builder(add: [attr])
+        end
+      else # is proc
+        (@builder_add_dynamically ||= { })[attr] = w
+      end
+
+      generate_assoc_info_method attr
+    end
+
+    def generate_assoc_info_method(attrs)
+      # 匹配关联模型 `name_info` 形式的 attr，并自动生成该方法
+      # 方法调用模型的 to_builder 方法并取得最终渲染结果
+      # unscoped 主要是为了支持去除软删除的默认 scope
+      Array(attrs).each do |attr|
+        next unless attr.to_s.match?(/_info/)
+        assoc_method = attr.to_s.gsub('_info', '')
+        next unless new.respond_to?(assoc_method) rescue next
+
+        define_method attr do
+          send(assoc_method)&.to_builder || nil
+        end
+
+        assoc_model = assoc_method.to_s.singularize
+        builder_rmv "#{assoc_model}_id".to_sym
+      end
+    end
+  end
+end

data/lib/builder_support/version.rb

@@ -0,0 +1,3 @@
+module BuilderSupport
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: builder_support
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- zhandao
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Provide a very simple way to transform ActiveRecord data into JSON output
+  based on JBuilder.
+email:
+- x@skippingcat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- builder_support.gemspec
+- lib/builder_support.rb
+- lib/builder_support/version.rb
+homepage: https://github.com/ikkiuchi/builder_support
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Provide a very simple way to transform ActiveRecord data into JSON output
+  based on JBuilder.
+test_files: []