corral 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +17 -0
- data/Gemfile +5 -0
- data/LICENSE.txt +22 -0
- data/README.md +62 -0
- data/Rakefile +1 -0
- data/corral.gemspec +22 -0
- data/lib/corral/version.rb +3 -0
- data/lib/corral.rb +51 -0
- metadata +87 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 Bryan Woods & Daniel Lacy
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,62 @@
|
|
1
|
+
# Corral
|
2
|
+
|
3
|
+
![Corral](http://cl.ly/image/0Q1E2Z451v2a/corral.jpg)
|
4
|
+
|
5
|
+
Use Corral to hide certain features in your application.
|
6
|
+
|
7
|
+
### Is it any good?
|
8
|
+
|
9
|
+
[Yes](http://news.ycombinator.com/item?id=3067434)
|
10
|
+
|
11
|
+
### What was your inspiration?
|
12
|
+
|
13
|
+
I love [Paddock](https://github.com/pivotalexperimental/paddock) (for which
|
14
|
+
Corral should be a nearly drop-in replacement), but
|
15
|
+
found its Rails environment specific approach to be too concrete for my
|
16
|
+
needs. Specifically, I wanted to toggle my features on arbitrary--or
|
17
|
+
at least callable--Ruby expressions.
|
18
|
+
|
19
|
+
## Setup
|
20
|
+
Put this somewhere like: `config/initializers/corral.rb`
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
include Corral
|
24
|
+
|
25
|
+
corral do
|
26
|
+
hide :torpedoes, when: -> { true }
|
27
|
+
hide :fun_and_games, when: -> { Rails.env.production? }
|
28
|
+
hide :cupcakes, if: ->(person) { person == "Bryan" }
|
29
|
+
end
|
30
|
+
```
|
31
|
+
|
32
|
+
("when" and "if" mean the same thing. Use whichever makes you happy.)
|
33
|
+
|
34
|
+
|
35
|
+
## Usage
|
36
|
+
|
37
|
+
```ruby
|
38
|
+
fire! if enabled?(:torpedoes)
|
39
|
+
sulk if disabled?(:cupcakes, "Bryan") # And I don't even *like* sweets!
|
40
|
+
```
|
41
|
+
|
42
|
+
## Installation
|
43
|
+
|
44
|
+
Add this line to your application's Gemfile:
|
45
|
+
|
46
|
+
gem 'corral'
|
47
|
+
|
48
|
+
And then execute:
|
49
|
+
|
50
|
+
$ bundle
|
51
|
+
|
52
|
+
Or install it yourself as:
|
53
|
+
|
54
|
+
$ gem install corral
|
55
|
+
|
56
|
+
## Contributing
|
57
|
+
|
58
|
+
1. Fork it
|
59
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
60
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
61
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
62
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
data/corral.gemspec
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'corral/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "corral"
|
8
|
+
spec.version = Corral::VERSION
|
9
|
+
spec.authors = ["Bryan Woods"]
|
10
|
+
spec.email = ["bryanwoods4e@gmail.com"]
|
11
|
+
spec.summary = "Use Corral to hide certain features in your application."
|
12
|
+
spec.homepage = "http://github.com/bryanwoods/corral"
|
13
|
+
spec.license = "MIT"
|
14
|
+
|
15
|
+
spec.files = `git ls-files`.split($/)
|
16
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
17
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
18
|
+
spec.require_paths = ["lib"]
|
19
|
+
|
20
|
+
spec.add_development_dependency "bundler", "~> 1.3"
|
21
|
+
spec.add_development_dependency "rake"
|
22
|
+
end
|
data/lib/corral.rb
ADDED
@@ -0,0 +1,51 @@
|
|
1
|
+
require "corral/version"
|
2
|
+
|
3
|
+
module Corral
|
4
|
+
class Feature
|
5
|
+
attr_accessor :feature, :condition, :disabled
|
6
|
+
|
7
|
+
def initialize(feature, condition, disabled)
|
8
|
+
@feature = feature
|
9
|
+
@condition = condition
|
10
|
+
@disabled = disabled
|
11
|
+
end
|
12
|
+
|
13
|
+
def self.push(name, condition, disabled = true)
|
14
|
+
@features ||= {}
|
15
|
+
@features[name] = new(name, condition, disabled)
|
16
|
+
end
|
17
|
+
|
18
|
+
def self.get(name)
|
19
|
+
(@features ||= {})[name]
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
def corral(&block)
|
24
|
+
instance_eval(&block)
|
25
|
+
end
|
26
|
+
|
27
|
+
def disabled?(feature, argument = nil)
|
28
|
+
!enabled?(feature, argument)
|
29
|
+
end
|
30
|
+
|
31
|
+
def enabled?(feature, argument = nil)
|
32
|
+
feature = Feature.get(feature)
|
33
|
+
return false unless feature && (condition = feature.condition)
|
34
|
+
|
35
|
+
if argument
|
36
|
+
!condition.call(argument)
|
37
|
+
else
|
38
|
+
!condition.call
|
39
|
+
end
|
40
|
+
end
|
41
|
+
|
42
|
+
def hide(feature, options = {})
|
43
|
+
condition = options[:when] || options[:if]
|
44
|
+
|
45
|
+
if condition && !condition.respond_to?(:call)
|
46
|
+
raise "'when' or 'if' condition must be a callable object"
|
47
|
+
end
|
48
|
+
|
49
|
+
Feature.push(feature, condition)
|
50
|
+
end
|
51
|
+
end
|
metadata
ADDED
@@ -0,0 +1,87 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: corral
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Bryan Woods
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2013-04-12 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: bundler
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ~>
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '1.3'
|
22
|
+
type: :development
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ~>
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '1.3'
|
30
|
+
- !ruby/object:Gem::Dependency
|
31
|
+
name: rake
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
33
|
+
none: false
|
34
|
+
requirements:
|
35
|
+
- - ! '>='
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: '0'
|
38
|
+
type: :development
|
39
|
+
prerelease: false
|
40
|
+
version_requirements: !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ! '>='
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
version: '0'
|
46
|
+
description:
|
47
|
+
email:
|
48
|
+
- bryanwoods4e@gmail.com
|
49
|
+
executables: []
|
50
|
+
extensions: []
|
51
|
+
extra_rdoc_files: []
|
52
|
+
files:
|
53
|
+
- .gitignore
|
54
|
+
- Gemfile
|
55
|
+
- LICENSE.txt
|
56
|
+
- README.md
|
57
|
+
- Rakefile
|
58
|
+
- corral.gemspec
|
59
|
+
- lib/corral.rb
|
60
|
+
- lib/corral/version.rb
|
61
|
+
homepage: http://github.com/bryanwoods/corral
|
62
|
+
licenses:
|
63
|
+
- MIT
|
64
|
+
post_install_message:
|
65
|
+
rdoc_options: []
|
66
|
+
require_paths:
|
67
|
+
- lib
|
68
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
69
|
+
none: false
|
70
|
+
requirements:
|
71
|
+
- - ! '>='
|
72
|
+
- !ruby/object:Gem::Version
|
73
|
+
version: '0'
|
74
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
75
|
+
none: false
|
76
|
+
requirements:
|
77
|
+
- - ! '>='
|
78
|
+
- !ruby/object:Gem::Version
|
79
|
+
version: '0'
|
80
|
+
requirements: []
|
81
|
+
rubyforge_project:
|
82
|
+
rubygems_version: 1.8.23
|
83
|
+
signing_key:
|
84
|
+
specification_version: 3
|
85
|
+
summary: Use Corral to hide certain features in your application.
|
86
|
+
test_files: []
|
87
|
+
has_rdoc:
|