scoped_attributes 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78381184544a7b5f61b066c19d17878251f8ae47c575386c44ec72a616c16b85
-  data.tar.gz: f149b82115e1aa5cd9caf2dede0e23a6375aa2eb03a4b22935583cf0afb1606d
+  metadata.gz: 58a14ad96009f828c2b5b2c35b5e5ce4d94892bf8b4c2baa91af37a151a4bf41
+  data.tar.gz: d6b10e21375ec889036324c6898bcde2071b89e7214dc9b738a257f9d25bea07
 SHA512:
-  metadata.gz: '086dfa13d6c36dd9c6ce46de3fe2844ff91de2cbf00258dbbe51418159fbf65590ee66d5f70fd95a480a8c254148cac24c6171ef02eacb5c7da3b12cfc98cbb8'
-  data.tar.gz: d67ccd206353b78b1ec44ee1a01bca25fea3282da4a1c0a462823eee9e0a82b7c6f0efa89d8a3cb701d7b633060db2a52c0ddeddc3fd92d7d0bdce659925b0f0
+  metadata.gz: ca6e6dd8d85d5439bc6a2baeca58891b73e2de07867b4d6ec388f3ba5c0b11c9feed39ba2cc4dc7b13f53b5e574a5392e868c878d9193b4e0732058ab33c288a
+  data.tar.gz: b658d27b41b696b2fa7c73c11ddb7b3e22c11b3184cd9297bc6c761e7fd4acded773e458c8b713658b384a80f424e1afa547d46d48c9201884e28081c0c94ae5

data/.github/workflows/ci.yml

@@ -0,0 +1,18 @@
+name: CI
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+      - name: Build and test with Rake
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake

data/README.md

@@ -1,4 +1,9 @@
 # ScopedAttributes
+![](https://github.com/shunhikita/scoped_attributes/workflows/CI/badge.svg?branch=master)
+
+scoped_attributes provides a module that allows you to add access restriction settings to attributes.
+By using this, you can easily create a wrapper model that returns only the information required for each different role.
+I think it can also be used to API Scope and view models.
 
 ## Installation
 
@@ -8,29 +13,21 @@ Add this line to your application's Gemfile:
 gem 'scoped_attributes'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install scoped_attributes
-
 ## Usage
 
-create scoped class
+You can create a wrapper model by including the ScopedAttributes module.
 
 ```rb
 class ApplicationScopedModel
   include ScopedAttributes
-  roles :admin, :crew
+  roles :admin, :manager 
 
   def admin?
     user.admin?
   end
 
-  def crew?
-    !admin?
+  def manager?
+    user.manager?
   end
 end
 ```
@@ -48,13 +45,15 @@ class ScopedCrew < ApplicationScopedModel
 end
 ```
 
-### for ActiveRecord
+### When using with ActiveRecord object
 
-usage
+Specify the target object in the first argument and the user with the role in the second argument.
+The acquisition of the attribute  is controlled by the condition specified in attribute class macro.
 
-current_user is crew and crew is not me
+For an ActiveRecord object, you can use the to_model method to get the model instance with the attribute selected.
 
 ```rb
+# current_user is not admin and not me
 scoped_crew = ScopedCrew.new(Crew.find(1), current_user)
 scoped_crew.name
 # => "hoge"
@@ -66,14 +65,15 @@ scoped_crew.attributes
 # => {:id=>1, :name=>"hoge"}
 
 scoped_crew.to_model
-=> #<Crew:xxx id: 1, name: "hoge">
+# => #<Crew:xxx id: 1, name: "hoge">
 
-Crew.find(1).scoped
-=> #<Crew:xxx id: 1, name: "hoge">
+Crew.find(1).scoped(current_user)
+# => #<Crew:xxx id: 1, name: "hoge">
 ```
 
-current_user is crew and crew is me
+
 ```rb
+# current_user is not admin but is me
 scoped_crew = ScopedCrew.new(Crew.find(1), current_user)
 scoped_crew.name
 # => "hoge"
@@ -85,33 +85,34 @@ scoped_crew.attributes
 # => {:id=>1, :name=>"hoge", :address=>"tokyo"}
 
 scoped_crew.to_model
-=> #<Crew:xxx id: 1, name: "hoge", address: "tokyo">
+# => #<Crew:xxx id: 1, name: "hoge", address: "tokyo">
 
-Crew.find(1).scoped
-=> #<Crew:xxx id: 1, name: "hoge", address: "tokyo">
+Crew.find(1).scoped(current_user)
+# => #<Crew:xxx id: 1, name: "hoge", address: "tokyo">
 ```
 
-current_user is admin
-
 ```rb
+# current_user is admin
 scoped_crew = ScopedCrew.new(Crew.find(1), current_user)
 scoped_crew.name
 # => "hoge"
 
 scoped_crew.address
-# =>  "tokyo"
+# => "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:xxx id: 1, name: "hoge", address: "tokyo", evaluation: "SS">
 
-Crew.find(1).scoped
-=> #<Crew:xxx id: 1, name: "hoge", address: "tokyo", evaluation: "SS">
+Crew.find(1).scoped(current_user)
+# => #<Crew:xxx id: 1, name: "hoge", address: "tokyo", evaluation: "SS">
 ```
 
-## for pure object
+## When using with PORO 
+
+ScopedAttributes module can also be used by including it in PORO(Plain Old Ruby Object).
 
 ```rb
 class ScopedCrew < ApplicationScopedModel
@@ -136,13 +137,6 @@ 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/lib/scoped_attributes/scopable.rb

@@ -1,3 +1,5 @@
+require "active_support/concern"
+
 module ScopedAttributes
   module Scopable
     extend ActiveSupport::Concern

data/lib/scoped_attributes/version.rb

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

data/lib/scoped_attributes.rb

@@ -1,7 +1,7 @@
 require "scoped_attributes/version"
 require "scoped_attributes/scopable"
 require 'scoped_attributes/railtie' if defined?(Rails)
-require "active_support/concern"
+require "active_support/all"
 
 module ScopedAttributes
   extend ActiveSupport::Concern
@@ -49,10 +49,6 @@ module ScopedAttributes
     end
   end
 
-  def model
-    (self.class.model_name || self.class.name.gsub("Scoped", "")).safe_constantize
-  end
-
   def as_json
     attributes
   end
@@ -60,7 +56,7 @@ module ScopedAttributes
   def to_model
     return nil if model.nil?
 
-    if object&.id.nil?
+    if object.try(:id).nil?
       model.new(attributes)
     else
       model.select(attributes.keys).find_by(id: object.id)
@@ -82,6 +78,9 @@ module ScopedAttributes
   end
 
   private
+  def model
+    (self.class.model_name || self.class.name.gsub("Scoped", "")).safe_constantize
+  end
 
   def visible?(only)
     return true if only.nil?
@@ -89,8 +88,8 @@ module ScopedAttributes
     case only
     when Array
       only.any? { |role| public_send("#{role}?") }
-    when String
-      only.public_send(string)
+    when Symbol
+      public_send(only)
     when Proc
       unbound_method = generate_method(:only_call, &only)
       !!unbound_method.bind(self).call

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scoped_attributes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - h1kita
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-15 00:00:00.000000000 Z
+date: 2019-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,6 +72,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"