visible_assignment 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6fa8d4e49ea29cb0caefed916505043202626e6c146c1f55fc9f6b4ee02f441b
+  data.tar.gz: 90e179d4b2142c452ff390870a82754bffa9a310284ffc5e31ed8f42b0241119
+SHA512:
+  metadata.gz: 8721158607151de2df48e209991aadaa7be7e07653368831121f7b4bd2c302d26232ffe4b84038517a62c5cd7ce87081b45fac43d365254651a7338b022ff34f
+  data.tar.gz: 166c0aea988a3e2acbe95e26343f43293375d0e2ccba5d54627ea15e3dda18af07263cf4fe7fff6bd7657c9137ee9fa01809f81942dd1cbc939f213e49860fae

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.17.3

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 visible_assignment.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    visible_assignment (0.1.0)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    i18n (1.5.3)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  visible_assignment!
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,104 @@
+# VisibleAssignment
+
+Change the way data is passed from ActionController to ActionView.
+
+Instead of copying all the instance variables of ActionController, VisibleAssignment copy only the explicit data to the instance variable of ActionView so that it can be used in the View.
+
+Resolve the poor visibility of what is in the instance variables used by View. For example, an instance variable defined by before_action or an instance variable defined by an included module ...etc
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'visible_assignment'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install visible_assignment
+
+
+## Configuration
+
+When set to true, the instance variable of the controller is also copied to the View instance variable.
+
+```rb
+VisibleAssignment.configure do |config|
+  config.enable_instance_variables = true # default false.
+end
+```
+
+## Usage
+
+When you want to pass an instance variable to View.
+
+```rb
+class BooksController < ApplicationController
+  def index
+    self.view_assign_variables = {
+      books: available_books,
+    } 
+  end
+  
+  def show
+    self.view_assign_variables = {
+      book: current_book,
+    }
+  end
+  
+  private
+    
+    def available_books
+      Book.available.page(params[:page])
+    end
+    
+    def current_book
+      available_books.find(params[:id])
+    end
+end
+```
+
+```books/index.erb
+<% @books.each do |book| %>
+  <p><%= book.title %></p>
+<% end %>
+```
+
+```books/show.erb
+<p><%= @book.title %></p>
+```
+
+When you want to pass an instance variable that is used for all actions to View
+
+```rb
+class ApplicationController < ActionController::Base
+  before_action :set_global_view_assign_variables
+  
+  def set_global_view_assign_variables
+    self.global_view_assign_variables = {
+      current_user: current_user,
+    }
+  end
+  
+  private
+  
+    def current_user
+      # ...
+    end
+end
+```
+
+## 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]/visible_assignment.

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 "visible_assignment"
+
+# 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/lib/visible_assignment.rb

@@ -0,0 +1,13 @@
+require "visible_assignment/version"
+
+require 'active_support'
+require 'visible_assignment/config'
+require 'visible_assignment/action_controller_extension'
+
+module VisibleAssignment
+  class Error < StandardError; end
+
+  ActiveSupport.on_load(:action_controller) do
+    include ActionControllerExtension
+  end
+end

data/lib/visible_assignment/action_controller_extension.rb

@@ -0,0 +1,25 @@
+module VisibleAssignment
+  module ActionControllerExtension
+    def view_assigns
+      if VisibleAssignment.config.enable_instance_variables
+        super.merge(all_view_assign_variables)
+      else
+        all_view_assign_variables
+      end
+    end
+
+    def view_assign_variables=(variables)
+      @_assign_variables = variables
+    end
+
+    def global_view_assign_variables=(variables)
+      @_global_assign_variables = variables
+    end
+
+    def all_view_assign_variables
+      @_assign_variables ||= {}
+      @_global_assign_variables ||= {}
+      @_global_assign_variables.merge(@_assign_variables)
+    end
+  end
+end

data/lib/visible_assignment/config.rb

@@ -0,0 +1,16 @@
+module VisibleAssignment
+  class << self
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= VisibleAssignment::Config.new
+    end
+  end
+
+  class Config
+    include ActiveSupport::Configurable
+    config_accessor :enable_instance_variables
+  end
+end

data/lib/visible_assignment/version.rb

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

data/visible_assignment.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "visible_assignment/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "visible_assignment"
+  spec.version       = VisibleAssignment::VERSION
+  spec.authors       = ["h1kita"]
+
+  spec.summary       = "change the way data is passed from ActionController to ActionView"
+  spec.description   = "change the way data is passed from ActionController to ActionView"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency 'activesupport'
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: visible_assignment
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- h1kita
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: change the way data is passed from ActionController to ActionView
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/visible_assignment.rb
+- lib/visible_assignment/action_controller_extension.rb
+- lib/visible_assignment/config.rb
+- lib/visible_assignment/version.rb
+- visible_assignment.gemspec
+homepage: 
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: change the way data is passed from ActionController to ActionView
+test_files: []