whitelisted-record 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: bd065fd7bc585215961cb7b9ddd1fdf3c07ae99f
4
+ data.tar.gz: e018bf28728464540e0aa8daf7485c03f0dfde35
5
+ SHA512:
6
+ metadata.gz: b7b78040d7f0be6f41d1dd519a9830895d108faeb37270fb9edbc6e63398d17516cffa09744409556af45abcea839c2b74465ce5bb7447d4c86b42e82ff36322
7
+ data.tar.gz: 59e7f0c1d72956b0e663afb11ab35546f2d8cc67064f063ad597a946835ad7ceec896d56fdfd424402fd8b77f4048efbc464fe874815a1675bbf5c9b28b4ddf0
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.0
5
+ before_install: gem install bundler -v 1.13.1
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in whitelisted-record.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 Edgar
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,53 @@
1
+ # WhitelistedRecord
2
+ This gem adds a little decorator for your objects that allow whitelist of methods. Possible user cases include when you need to dynamically display whitelisted attributes in your view based on some criteria.
3
+
4
+ ## Usage
5
+ Simply create a decorator like this to whitelist what you want visible:
6
+ ```
7
+ user = WhitelistedRecord(user, [:first_name, :last_name, :age])
8
+ ```
9
+
10
+ ## Configuration
11
+ You can set default whitelist with a configuration. For example, in a Rails app you can put this in an initializer:
12
+ ```
13
+ WhitelistedRecord.configure do |config|
14
+ config.whitelist = [:first_name, :last_name]
15
+ end
16
+ ```
17
+
18
+
19
+ ## Installation
20
+
21
+ Add this line to your application's Gemfile:
22
+
23
+ ```ruby
24
+ gem 'whitelisted-record'
25
+ ```
26
+
27
+ And then execute:
28
+
29
+ $ bundle
30
+
31
+ Or install it yourself as:
32
+
33
+ $ gem install whitelisted-record
34
+
35
+ ## Usage
36
+
37
+ TODO: Write usage instructions here
38
+
39
+ ## Development
40
+
41
+ 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.
42
+
43
+ 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).
44
+
45
+ ## Contributing
46
+
47
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/whitelisted-record.
48
+
49
+
50
+ ## License
51
+
52
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
53
+
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "whitelisted/record"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,15 @@
1
+ require "whitelisted_record/version"
2
+ require "whitelisted_record/decorator"
3
+ require "whitelisted_record/configuration"
4
+
5
+ module WhitelistedRecord
6
+
7
+ def self.new
8
+ Decorator.new
9
+ end
10
+
11
+ def self.configure(&block)
12
+ Decorator.configure(&block)
13
+ end
14
+
15
+ end
@@ -0,0 +1,10 @@
1
+ module WhitelistedRecord
2
+ class Configuration
3
+ attr_accessor :whitelist
4
+
5
+ def initialize
6
+ @whitelist = nil
7
+ end
8
+
9
+ end
10
+ end
@@ -0,0 +1,34 @@
1
+ module WhitelistedRecord
2
+ class Decorator
3
+ class << self
4
+ attr_accessor :configuration
5
+ end
6
+
7
+ attr_reader :record
8
+
9
+ def initialize(record, whitelist = nil)
10
+ @record = record
11
+ @whitelist = !whitelist.nil? && whitelist.length > 0 ? whitelist : WhitelistedRecord::Decorator.configuration.whitelist
12
+ end
13
+
14
+ def respond_to?(method_name, *args, &block)
15
+ @record.respond_to?(method_name, *args, &block)
16
+ end
17
+
18
+ def method_missing(method, *args, &block)
19
+ if @whitelist.nil? || @whitelist.include?(method)
20
+ @record.send(method, *args, &block)
21
+ else
22
+ nil
23
+ end
24
+ end
25
+
26
+ def self.configuration
27
+ @configuration ||= WhitelistedRecord::Configuration.new
28
+ end
29
+
30
+ def self.configure
31
+ yield(configuration)
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,5 @@
1
+ module WhitelistedRecord
2
+ module Version
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
@@ -0,0 +1,28 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'whitelisted_record/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "whitelisted-record"
8
+ spec.version = WhitelistedRecord::Version::VERSION
9
+ spec.authors = ["Edgar"]
10
+ spec.email = ["zorro.ej@gmail.com"]
11
+
12
+ spec.summary = "A simple gem to allow whiteilst methods"
13
+ spec.description = "This gem provides a decorator to whitelist methods"
14
+ spec.homepage = "https://github.com/ej2015/whitelisted-record.git"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
+ f.match(%r{^(test|spec|features)/})
19
+ end
20
+ spec.bindir = "exe"
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.13"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "rspec", "~> 3.0"
27
+ spec.add_development_dependency "activesupport", "~> 5.0"
28
+ end
metadata ADDED
@@ -0,0 +1,114 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: whitelisted-record
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Edgar
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2018-12-08 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.13'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.13'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: activesupport
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '5.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '5.0'
69
+ description: This gem provides a decorator to whitelist methods
70
+ email:
71
+ - zorro.ej@gmail.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".rspec"
78
+ - ".travis.yml"
79
+ - Gemfile
80
+ - LICENSE.txt
81
+ - README.md
82
+ - Rakefile
83
+ - bin/console
84
+ - bin/setup
85
+ - lib/whitelisted_record.rb
86
+ - lib/whitelisted_record/configuration.rb
87
+ - lib/whitelisted_record/decorator.rb
88
+ - lib/whitelisted_record/version.rb
89
+ - whitelisted-record.gemspec
90
+ homepage: https://github.com/ej2015/whitelisted-record.git
91
+ licenses:
92
+ - MIT
93
+ metadata: {}
94
+ post_install_message:
95
+ rdoc_options: []
96
+ require_paths:
97
+ - lib
98
+ required_ruby_version: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - ">="
101
+ - !ruby/object:Gem::Version
102
+ version: '0'
103
+ required_rubygems_version: !ruby/object:Gem::Requirement
104
+ requirements:
105
+ - - ">="
106
+ - !ruby/object:Gem::Version
107
+ version: '0'
108
+ requirements: []
109
+ rubyforge_project:
110
+ rubygems_version: 2.6.14
111
+ signing_key:
112
+ specification_version: 4
113
+ summary: A simple gem to allow whiteilst methods
114
+ test_files: []