confucious 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
data/.document ADDED
@@ -0,0 +1,5 @@
1
+ lib/**/*.rb
2
+ bin/*
3
+ -
4
+ features/**/*.feature
5
+ LICENSE.txt
data/Gemfile ADDED
@@ -0,0 +1,15 @@
1
+ source "http://rubygems.org"
2
+ # Add dependencies required to use your gem here.
3
+ # Example:
4
+ # gem "activesupport", ">= 2.3.5"
5
+ gem 'hashie'
6
+ gem 'rdoc'
7
+
8
+ # Add dependencies to develop your gem here.
9
+ # Include everything needed to run rake, tests, features, etc.
10
+ group :development do
11
+ gem "shoulda", ">= 0"
12
+ gem "bundler", "~> 1.0.0"
13
+ gem "jeweler", "~> 1.6.4"
14
+ gem "rcov", ">= 0"
15
+ end
data/Gemfile.lock ADDED
@@ -0,0 +1,24 @@
1
+ GEM
2
+ remote: http://rubygems.org/
3
+ specs:
4
+ git (1.2.5)
5
+ hashie (1.0.0)
6
+ jeweler (1.6.4)
7
+ bundler (~> 1.0)
8
+ git (>= 1.2.5)
9
+ rake
10
+ rake (0.9.2)
11
+ rcov (0.9.9)
12
+ rdoc (3.8)
13
+ shoulda (2.11.3)
14
+
15
+ PLATFORMS
16
+ ruby
17
+
18
+ DEPENDENCIES
19
+ bundler (~> 1.0.0)
20
+ hashie
21
+ jeweler (~> 1.6.4)
22
+ rcov
23
+ rdoc
24
+ shoulda
data/LICENSE.txt ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2011 Ari Lerner
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.rdoc ADDED
@@ -0,0 +1,44 @@
1
+ = confu
2
+
3
+ I found myself duplicating this code, so I wrote it into a gem.
4
+
5
+ This is an `incredibly` simple gem with only a few lines of code and a few helpers to help define a configuration for a class.
6
+
7
+ == Usage
8
+
9
+ class MyClass
10
+ include Confu
11
+
12
+ configuration do
13
+ property :a, :default => "a_default"
14
+ property :no_default
15
+ end
16
+ end
17
+
18
+ The `property` method uses the same syntax as the [Hashie::Dash](http://github.com/intridea/hashie) gem uses ('cause that's how the config object is used, anyway).
19
+
20
+ To configure in use:
21
+
22
+ MyClass.configure do |c|
23
+ c.a = "new value for a"
24
+ end
25
+
26
+ Then the `MyClass` that included the module has a magic method called `config`. This `config` method will contain the configuration options available at runtime. Pretty easy.
27
+
28
+ MyClass.new.config.a # new value for a
29
+
30
+ == Contributing to confu
31
+
32
+ * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
33
+ * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
34
+ * Fork the project
35
+ * Start a feature/bugfix branch
36
+ * Commit and push until you are happy with your contribution
37
+ * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
38
+ * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
39
+
40
+ == Copyright
41
+
42
+ Copyright (c) 2011 Ari Lerner. See LICENSE.txt for
43
+ further details.
44
+
data/Rakefile ADDED
@@ -0,0 +1,53 @@
1
+ # encoding: utf-8
2
+
3
+ require 'rubygems'
4
+ require 'bundler'
5
+ begin
6
+ Bundler.setup(:default, :development)
7
+ rescue Bundler::BundlerError => e
8
+ $stderr.puts e.message
9
+ $stderr.puts "Run `bundle install` to install missing gems"
10
+ exit e.status_code
11
+ end
12
+ require 'rake'
13
+
14
+ require 'jeweler'
15
+ Jeweler::Tasks.new do |gem|
16
+ # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
17
+ gem.name = "confucious"
18
+ gem.homepage = "http://github.com/auser/confu"
19
+ gem.license = "MIT"
20
+ gem.summary = %Q{Drop-dead simple configuration}
21
+ gem.description = %Q{Drop-dead simple configuration for an application. See `README.rdoc` for details}
22
+ gem.email = "arilerner@mac.com"
23
+ gem.authors = ["Ari Lerner"]
24
+ # dependencies defined in Gemfile
25
+ end
26
+ Jeweler::RubygemsDotOrgTasks.new
27
+
28
+ require 'rake/testtask'
29
+ Rake::TestTask.new(:test) do |test|
30
+ test.libs << 'lib' << 'test'
31
+ test.pattern = 'test/**/test_*.rb'
32
+ test.verbose = true
33
+ end
34
+
35
+ require 'rcov/rcovtask'
36
+ Rcov::RcovTask.new do |test|
37
+ test.libs << 'test'
38
+ test.pattern = 'test/**/test_*.rb'
39
+ test.verbose = true
40
+ test.rcov_opts << '--exclude "gems/*"'
41
+ end
42
+
43
+ task :default => :test
44
+
45
+ require 'rdoc/task'
46
+ Rake::RDocTask.new do |rdoc|
47
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
48
+
49
+ rdoc.rdoc_dir = 'rdoc'
50
+ rdoc.title = "confu #{version}"
51
+ rdoc.rdoc_files.include('README*')
52
+ rdoc.rdoc_files.include('lib/**/*.rb')
53
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.0.1
@@ -0,0 +1,7 @@
1
+ module Confu
2
+ class Config < Hashie::Dash
3
+
4
+ property :logger, :default => ::Logger.new(STDOUT)
5
+
6
+ end
7
+ end
data/lib/confu.rb ADDED
@@ -0,0 +1,43 @@
1
+ $:.unshift(File.expand_path("confu", File.dirname(__FILE__)))
2
+ require 'hashie'
3
+ require 'logger'
4
+
5
+ require 'config'
6
+
7
+ module Confu
8
+ module ClassMethods
9
+ # This allows us to do cool things like set our
10
+ # own configuration in a block
11
+ #
12
+ # Usage:
13
+ # [Module].configure do
14
+ #
15
+ # end
16
+ def configure(opts={}, &block)
17
+ @config = nil # reset!
18
+ mash = Hashie::Mash.new(opts)
19
+ yield mash if block_given?
20
+ Confu::Config.defaults.merge!(mash)
21
+ end
22
+
23
+ def configuration(&block)
24
+ Confu::Config.instance_eval(&block) if block_given?
25
+ end
26
+
27
+ def config
28
+ @config ||= Confu::Config.new
29
+ end
30
+ end
31
+
32
+ module InstanceMethods
33
+ def config
34
+ self.class.config
35
+ end
36
+
37
+ end
38
+
39
+ def self.included(receiver)
40
+ receiver.extend ClassMethods
41
+ receiver.send :include, InstanceMethods
42
+ end
43
+ end
data/test/helper.rb ADDED
@@ -0,0 +1,18 @@
1
+ require 'rubygems'
2
+ require 'bundler'
3
+ begin
4
+ Bundler.setup(:default, :development)
5
+ rescue Bundler::BundlerError => e
6
+ $stderr.puts e.message
7
+ $stderr.puts "Run `bundle install` to install missing gems"
8
+ exit e.status_code
9
+ end
10
+ require 'test/unit'
11
+ require 'shoulda'
12
+
13
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
14
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
15
+ require 'confu'
16
+
17
+ class Test::Unit::TestCase
18
+ end
@@ -0,0 +1,48 @@
1
+ require 'helper'
2
+
3
+ class TestConfu < Test::Unit::TestCase
4
+ context "Confu" do
5
+
6
+ class TestConfuDude
7
+ include Confu
8
+
9
+ configuration do
10
+ property :useless, :default => "useless"
11
+ property :no_default
12
+ property :never_set_with_a_default
13
+ end
14
+ end
15
+
16
+ setup do
17
+ @tcd = TestConfuDude.new
18
+ @config = @tcd.config
19
+ end
20
+
21
+ should "be able to set configuration" do
22
+ TestConfuDude.configure do |c|
23
+ c.no_default = "this is a value"
24
+ end
25
+
26
+ assert_equal "this is a value", TestConfuDude.new.config.no_default
27
+ end
28
+
29
+ should "be able to be included in another class" do
30
+ assert_equal @config.useless, "useless"
31
+ end
32
+
33
+ should "have a nil value for a property without a default" do
34
+ assert_nil @config.never_set_with_a_default
35
+ end
36
+
37
+ should "raise a NoMethodError if the method isn't 'configured'" do
38
+ assert_raises NoMethodError do
39
+ @config.box_car
40
+ end
41
+ end
42
+
43
+ should "only create one instance of config" do
44
+ assert_equal @config, TestConfuDude.new.config
45
+ end
46
+
47
+ end
48
+ end
metadata ADDED
@@ -0,0 +1,135 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: confucious
3
+ version: !ruby/object:Gem::Version
4
+ prerelease:
5
+ version: 0.0.1
6
+ platform: ruby
7
+ authors:
8
+ - Ari Lerner
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+
13
+ date: 2011-07-29 00:00:00 -07:00
14
+ default_executable:
15
+ dependencies:
16
+ - !ruby/object:Gem::Dependency
17
+ name: hashie
18
+ requirement: &id001 !ruby/object:Gem::Requirement
19
+ none: false
20
+ requirements:
21
+ - - ">="
22
+ - !ruby/object:Gem::Version
23
+ version: "0"
24
+ type: :runtime
25
+ prerelease: false
26
+ version_requirements: *id001
27
+ - !ruby/object:Gem::Dependency
28
+ name: rdoc
29
+ requirement: &id002 !ruby/object:Gem::Requirement
30
+ none: false
31
+ requirements:
32
+ - - ">="
33
+ - !ruby/object:Gem::Version
34
+ version: "0"
35
+ type: :runtime
36
+ prerelease: false
37
+ version_requirements: *id002
38
+ - !ruby/object:Gem::Dependency
39
+ name: shoulda
40
+ requirement: &id003 !ruby/object:Gem::Requirement
41
+ none: false
42
+ requirements:
43
+ - - ">="
44
+ - !ruby/object:Gem::Version
45
+ version: "0"
46
+ type: :development
47
+ prerelease: false
48
+ version_requirements: *id003
49
+ - !ruby/object:Gem::Dependency
50
+ name: bundler
51
+ requirement: &id004 !ruby/object:Gem::Requirement
52
+ none: false
53
+ requirements:
54
+ - - ~>
55
+ - !ruby/object:Gem::Version
56
+ version: 1.0.0
57
+ type: :development
58
+ prerelease: false
59
+ version_requirements: *id004
60
+ - !ruby/object:Gem::Dependency
61
+ name: jeweler
62
+ requirement: &id005 !ruby/object:Gem::Requirement
63
+ none: false
64
+ requirements:
65
+ - - ~>
66
+ - !ruby/object:Gem::Version
67
+ version: 1.6.4
68
+ type: :development
69
+ prerelease: false
70
+ version_requirements: *id005
71
+ - !ruby/object:Gem::Dependency
72
+ name: rcov
73
+ requirement: &id006 !ruby/object:Gem::Requirement
74
+ none: false
75
+ requirements:
76
+ - - ">="
77
+ - !ruby/object:Gem::Version
78
+ version: "0"
79
+ type: :development
80
+ prerelease: false
81
+ version_requirements: *id006
82
+ description: Drop-dead simple configuration for an application. See `README.rdoc` for details
83
+ email: arilerner@mac.com
84
+ executables: []
85
+
86
+ extensions: []
87
+
88
+ extra_rdoc_files:
89
+ - LICENSE.txt
90
+ - README.rdoc
91
+ files:
92
+ - .document
93
+ - Gemfile
94
+ - Gemfile.lock
95
+ - LICENSE.txt
96
+ - README.rdoc
97
+ - Rakefile
98
+ - VERSION
99
+ - lib/confu.rb
100
+ - lib/confu/config.rb
101
+ - test/helper.rb
102
+ - test/test_confu.rb
103
+ has_rdoc: true
104
+ homepage: http://github.com/auser/confu
105
+ licenses:
106
+ - MIT
107
+ post_install_message:
108
+ rdoc_options: []
109
+
110
+ require_paths:
111
+ - lib
112
+ required_ruby_version: !ruby/object:Gem::Requirement
113
+ none: false
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ hash: -2148341052206315511
118
+ segments:
119
+ - 0
120
+ version: "0"
121
+ required_rubygems_version: !ruby/object:Gem::Requirement
122
+ none: false
123
+ requirements:
124
+ - - ">="
125
+ - !ruby/object:Gem::Version
126
+ version: "0"
127
+ requirements: []
128
+
129
+ rubyforge_project:
130
+ rubygems_version: 1.6.2
131
+ signing_key:
132
+ specification_version: 3
133
+ summary: Drop-dead simple configuration
134
+ test_files: []
135
+