scoped_attributes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 78381184544a7b5f61b066c19d17878251f8ae47c575386c44ec72a616c16b85
+  data.tar.gz: f149b82115e1aa5cd9caf2dede0e23a6375aa2eb03a4b22935583cf0afb1606d
+SHA512:
+  metadata.gz: '086dfa13d6c36dd9c6ce46de3fe2844ff91de2cbf00258dbbe51418159fbf65590ee66d5f70fd95a480a8c254148cac24c6171ef02eacb5c7da3b12cfc98cbb8'
+  data.tar.gz: d67ccd206353b78b1ec44ee1a01bca25fea3282da4a1c0a462823eee9e0a82b7c6f0efa89d8a3cb701d7b633060db2a52c0ddeddc3fd92d7d0bdce659925b0f0

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.5
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in scoped_attributes.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    scoped_attributes (0.1.0)
+      activesupport (>= 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.13.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  scoped_attributes!
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -0,0 +1,148 @@
+# ScopedAttributes
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scoped_attributes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scoped_attributes
+
+## Usage
+
+create scoped class
+
+```rb
+class ApplicationScopedModel
+  include ScopedAttributes
+  roles :admin, :crew
+
+  def admin?
+    user.admin?
+  end
+
+  def crew?
+    !admin?
+  end
+end
+```
+
+```rb
+class ScopedCrew < ApplicationScopedModel
+  attribute :id
+  attribute :name
+  attribute :address, only: proc { me? || admin? } # Proc
+  attribute :evaluation, only: %i(admin) # role names (Array)
+
+  def me?
+    id == user.crew_id
+  end
+end
+```
+
+### for ActiveRecord
+
+usage
+
+current_user is crew and crew is not me
+
+```rb
+scoped_crew = ScopedCrew.new(Crew.find(1), current_user)
+scoped_crew.name
+# => "hoge"
+
+scoped_crew.address
+# => nil
+
+scoped_crew.attributes
+# => {:id=>1, :name=>"hoge"}
+
+scoped_crew.to_model
+=> #<Crew:xxx id: 1, name: "hoge">
+
+Crew.find(1).scoped
+=> #<Crew:xxx id: 1, name: "hoge">
+```
+
+current_user is crew and crew is me
+```rb
+scoped_crew = ScopedCrew.new(Crew.find(1), current_user)
+scoped_crew.name
+# => "hoge"
+
+scoped_crew.address
+# => "tokyo"
+
+scoped_crew.attributes
+# => {:id=>1, :name=>"hoge", :address=>"tokyo"}
+
+scoped_crew.to_model
+=> #<Crew:xxx id: 1, name: "hoge", address: "tokyo">
+
+Crew.find(1).scoped
+=> #<Crew:xxx id: 1, name: "hoge", address: "tokyo">
+```
+
+current_user is admin
+
+```rb
+scoped_crew = ScopedCrew.new(Crew.find(1), current_user)
+scoped_crew.name
+# => "hoge"
+
+scoped_crew.address
+# =>  "tokyo"
+
+scoped_crew.attributes
+# => {:id=>1, :name=>"hoge", :address=>"tokyo", :evaluation=>"SS"}
+
+scoped_crew.to_model
+=> #<Crew:xxx id: 1, name: "hoge", address: "tokyo", evaluation: "SS">
+
+Crew.find(1).scoped
+=> #<Crew:xxx id: 1, name: "hoge", address: "tokyo", evaluation: "SS">
+```
+
+## for pure object
+
+```rb
+class ScopedCrew < ApplicationScopedModel
+  attribute :name
+  attribute :addres
+  attribute :evaluation, only: %i(admin)
+end
+
+class CustomCrew
+  attr_accessor :name, :address, :evaluation
+  
+  def initialize(name, address, evaluation)
+    self.name = name
+    self.address = address
+    self.evaluation = evaluation
+  end
+end
+
+crew = CustomCrew.new("hoge", "tokyo", "SS")
+scoped_crew = ScopedCrew.new(crew, current_user)
+scoped_crew.attributes
+# => {:name=>"hoge", :address=>"tokyo"}
+```
+
+
+## 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/shunhikita/scoped_attributes.

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 "scoped_attributes"
+
+# 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/scoped_attributes/railtie.rb

@@ -0,0 +1,15 @@
+require 'rails/railtie'
+
+module ScopedAttributes
+  class Railtie < Rails::Railtie
+    initializer 'scoped_attributes.setup_orm' do
+      [:active_record].each do |orm|
+        ActiveSupport.on_load orm do
+          self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            include ScopedAttributes::Scopable
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/scoped_attributes/scopable.rb

@@ -0,0 +1,10 @@
+module ScopedAttributes
+  module Scopable
+    extend ActiveSupport::Concern
+
+    def scoped(user)
+      klass_name = "Scoped#{self.model_name}"
+      klass_name.constantize.new(self, user).to_model
+    end
+  end
+end

data/lib/scoped_attributes/version.rb

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

data/lib/scoped_attributes.rb

@@ -0,0 +1,111 @@
+require "scoped_attributes/version"
+require "scoped_attributes/scopable"
+require 'scoped_attributes/railtie' if defined?(Rails)
+require "active_support/concern"
+
+module ScopedAttributes
+  extend ActiveSupport::Concern
+  class Error < StandardError; end
+
+  def initialize(object, user)
+    self.object = object
+    self.user = user
+  end
+
+  included do
+    class_attribute :attributes_registry, instance_accessor: false
+    class_attribute :model_name, instance_accessor: true
+    self.attributes_registry = {}
+
+    attr_accessor :object, :user
+  end
+
+  class_methods do
+    def roles(*role_names)
+      role_names.each do |role_name|
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{role_name}?
+              raise NotImplementedError.new("You must implement #{self.class}##{__method__}") 
+            end
+        RUBY
+      end
+    end
+
+    def attribute(name, **options)
+      add_attribute_registry(name.to_sym, options)
+      define_attribute_reader(name.to_sym, options)
+    end
+
+    def add_attribute_registry(name, options)
+      self.attributes_registry.merge!(name => options)
+    end
+
+    def define_attribute_reader(name, options)
+      only = options.fetch(:only, nil)
+
+      define_method name do
+        object.public_send(name) if visible?(only)
+      end
+    end
+  end
+
+  def model
+    (self.class.model_name || self.class.name.gsub("Scoped", "")).safe_constantize
+  end
+
+  def as_json
+    attributes
+  end
+
+  def to_model
+    return nil if model.nil?
+
+    if object&.id.nil?
+      model.new(attributes)
+    else
+      model.select(attributes.keys).find_by(id: object.id)
+    end
+  end
+
+  def attributes(include_key: false)
+    attributes = {}
+    self.class.attributes_registry.each do |name, options|
+      only = options.fetch(:only, nil)
+
+      if visible?(only)
+        attributes[name] = object.public_send(name)
+      elsif include_key
+        attributes[name] = nil
+      end
+    end
+    attributes
+  end
+
+  private
+
+  def visible?(only)
+    return true if only.nil?
+
+    case only
+    when Array
+      only.any? { |role| public_send("#{role}?") }
+    when String
+      only.public_send(string)
+    when Proc
+      unbound_method = generate_method(:only_call, &only)
+      !!unbound_method.bind(self).call
+    else
+      false
+    end
+  end
+
+  def generate_method(method_name, &block)
+    method = nil
+    Module.new do
+      define_method method_name, &block
+      method = instance_method method_name
+      remove_method method_name
+    end
+    method
+  end
+end

data/scoped_attributes.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "scoped_attributes/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "scoped_attributes"
+  spec.version       = ScopedAttributes::VERSION
+  spec.authors       = ["h1kita"]
+
+  spec.summary       = "Support to attributes visible for each roles."
+  spec.description   = "Support to attributes visible for each roles."
+
+  spec.metadata["source_code_uri"] = "https://github.com/shunhikita/scoped_attributes"
+
+  # 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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "activesupport", ">= 5.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: scoped_attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- h1kita
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Support to attributes visible for each roles.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/scoped_attributes.rb
+- lib/scoped_attributes/railtie.rb
+- lib/scoped_attributes/scopable.rb
+- lib/scoped_attributes/version.rb
+- scoped_attributes.gemspec
+homepage: 
+licenses: []
+metadata:
+  source_code_uri: https://github.com/shunhikita/scoped_attributes
+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.3
+signing_key: 
+specification_version: 4
+summary: Support to attributes visible for each roles.
+test_files: []