├── .gitignore ├── features ├── support │ ├── bobo.config │ ├── config_it.rb │ └── env.rb ├── config.feature └── steps │ └── config_steps.rb ├── spec ├── spec_helper.rb └── mixlib │ └── config_spec.rb ├── script ├── destroy └── generate ├── NOTICE ├── README.rdoc ├── Rakefile ├── lib └── mixlib │ └── config.rb └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | pkg/ 2 | -------------------------------------------------------------------------------- /features/support/bobo.config: -------------------------------------------------------------------------------- 1 | # Sample config file 2 | foo 'bar' 3 | baz 'snarl' -------------------------------------------------------------------------------- /spec/spec_helper.rb: -------------------------------------------------------------------------------- 1 | $TESTING=true 2 | $:.push File.join(File.dirname(__FILE__), '..', 'lib') 3 | 4 | require 'mixlib/config' 5 | 6 | class ConfigIt 7 | extend Mixlib::Config 8 | end 9 | -------------------------------------------------------------------------------- /script/destroy: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..')) 3 | 4 | begin 5 | require 'rubigen' 6 | rescue LoadError 7 | require 'rubygems' 8 | require 'rubigen' 9 | end 10 | require 'rubigen/scripts/destroy' 11 | 12 | ARGV.shift if ['--help', '-h'].include?(ARGV[0]) 13 | RubiGen::Base.use_component_sources! [:newgem_simple, :test_unit] 14 | RubiGen::Scripts::Destroy.new.run(ARGV) 15 | -------------------------------------------------------------------------------- /script/generate: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..')) 3 | 4 | begin 5 | require 'rubigen' 6 | rescue LoadError 7 | require 'rubygems' 8 | require 'rubigen' 9 | end 10 | require 'rubigen/scripts/generate' 11 | 12 | ARGV.shift if ['--help', '-h'].include?(ARGV[0]) 13 | RubiGen::Base.use_component_sources! [:newgem_simple, :test_unit] 14 | RubiGen::Scripts::Generate.new.run(ARGV) 15 | -------------------------------------------------------------------------------- /features/config.feature: -------------------------------------------------------------------------------- 1 | Feature: Configure an application 2 | In order to make it trivial to configure an application 3 | As a Developer 4 | I want to utilize a simple configuration object 5 | 6 | Scenario: Set a configuration option to a string 7 | Given a configuration class 8 | When I set 'foo' to 'bar' 9 | Then config option 'foo' is 'bar' 10 | 11 | Scenario: Set a configuration option to an Array 12 | Given a configuration class 13 | When I set 'foo' to: 14 | |key| 15 | |bar| 16 | |baz| 17 | Then an array is returned for 'foo' 18 | 19 | Scenario: Set a configuration option from a file 20 | Given a configuration file 'bobo.config' 21 | When I load the configuration 22 | Then config option 'foo' is 'bar' 23 | And config option 'baz' is 'snarl' 24 | -------------------------------------------------------------------------------- /features/support/config_it.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Author:: Adam Jacob () 3 | # Copyright:: Copyright (c) 2008 Opscode, Inc. 4 | # License:: Apache License, Version 2.0 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | $: << File.join(File.dirname(__FILE__), '..', '..', 'lib') 20 | require 'mixlib/config' 21 | 22 | class ConfigIt 23 | extend Mixlib::Config 24 | end -------------------------------------------------------------------------------- /features/support/env.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Author:: Adam Jacob () 3 | # Copyright:: Copyright (c) 2008 Opscode, Inc. 4 | # License:: Apache License, Version 2.0 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | $: << File.join(File.dirname(__FILE__), '..', '..', 'lib') 20 | 21 | require 'spec/expectations' 22 | require 'mixlib/config' 23 | require 'tmpdir' 24 | require 'stringio' 25 | 26 | class MyWorld 27 | end 28 | 29 | World do 30 | MyWorld.new 31 | end 32 | -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | Mixin::Config NOTICE 2 | ================= 3 | 4 | Developed at Opscode (http://www.opscode.com). 5 | 6 | * Copyright 2009, Opscode, Inc. 7 | 8 | Mixin::Config incorporates code from Chef. The Chef notice file follows: 9 | 10 | Chef NOTICE 11 | =========== 12 | 13 | Developed at Opscode (http://www.opscode.com). 14 | 15 | Contributors and Copyright holders: 16 | 17 | * Copyright 2008, Adam Jacob 18 | * Copyright 2008, Arjuna Christensen 19 | * Copyright 2008, Bryan McLellan 20 | * Copyright 2008, Ezra Zygmuntowicz 21 | * Copyright 2009, Sean Cribbs 22 | * Copyright 2009, Christopher Brown 23 | * Copyright 2009, Thom May 24 | 25 | Chef incorporates code modified from Open4 (http://www.codeforpeople.com/lib/ruby/open4/), which was written by Ara T. Howard. 26 | 27 | Chef incorporates code modified from Merb (http://www.merbivore.com), which is Copyright (c) 2008 Engine Yard. 28 | -------------------------------------------------------------------------------- /README.rdoc: -------------------------------------------------------------------------------- 1 | == Mixlib::Config 2 | 3 | Mixlib::Config provides a class-based configuration object, like the one used in Chef. To use in your project: 4 | 5 | require 'rubygems' 6 | require 'mixlib/config' 7 | 8 | class MyConfig 9 | extend(Mixlib::Config) 10 | configure do |c| 11 | c[:first_value] = 'something' 12 | c[:other_value] = 'something_else' 13 | end 14 | end 15 | 16 | Or... 17 | 18 | class MyConfig 19 | extend(Mixlib::Config) 20 | 21 | first_value 'something' 22 | other_value 'something_else' 23 | end 24 | 25 | To check a configuration variable: 26 | 27 | MyConfig.first_value # returns 'something' 28 | MyConfig[:first_value] # returns 'something' 29 | 30 | To change a configuration variable at runtime: 31 | 32 | MyConfig.first_value('foobar') # sets first_value to 'foobar' 33 | MyConfig[:first_value] = 'foobar' # sets first_value to 'foobar' 34 | 35 | You should populate your class with the default values for every configuration variable that might be accessed. If you try and access a variable that does not exist, Mixlib::Config will throw an . 36 | 37 | To load a ruby configuration file (which will evaluate in the context of your configuration class): 38 | 39 | MyConfig.from_file('your_config_file.rb') 40 | 41 | Enjoy! 42 | -------------------------------------------------------------------------------- /features/steps/config_steps.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Author:: Adam Jacob () 3 | # Copyright:: Copyright (c) 2008 Opscode, Inc. 4 | # License:: Apache License, Version 2.0 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | Given /^a configuration class$/ do 20 | end 21 | 22 | When /^I set '(.+)' to '(.+)'$/ do |key, value| 23 | ConfigIt[key.to_sym] = value 24 | end 25 | 26 | Then /^config option '(.+)' is '(.+)'$/ do |key, value| 27 | ConfigIt[key.to_sym].should == value 28 | end 29 | 30 | When /^I set '(.+)' to:$/ do |key, foo_table| 31 | ConfigIt[key.to_sym] = Array.new 32 | foo_table.hashes.each do |hash| 33 | ConfigIt[key.to_sym] << hash['key'] 34 | end 35 | end 36 | 37 | Then /^an array is returned for '(.+)'$/ do |key| 38 | ConfigIt[key.to_sym].should be_a_kind_of(Array) 39 | end 40 | 41 | Given /^a configuration file '(.+)'$/ do |filename| 42 | @config_file = File.join(File.dirname(__FILE__), "..", "support", filename) 43 | end 44 | 45 | When /^I load the configuration$/ do 46 | ConfigIt.from_file(@config_file) 47 | end 48 | 49 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | require 'rubygems' 2 | require 'rake/gempackagetask' 3 | require 'rubygems/specification' 4 | require 'date' 5 | require 'spec/rake/spectask' 6 | require 'cucumber/rake/task' 7 | 8 | 9 | GEM = "mixlib-config" 10 | GEM_VERSION = "1.0.0" 11 | AUTHOR = "Opscode, Inc." 12 | EMAIL = "info@opscode.com" 13 | HOMEPAGE = "http://www.opscode.com" 14 | SUMMARY = "A class based config mixin, similar to the one found in Chef." 15 | 16 | spec = Gem::Specification.new do |s| 17 | s.name = GEM 18 | s.version = GEM_VERSION 19 | s.platform = Gem::Platform::RUBY 20 | s.has_rdoc = true 21 | s.extra_rdoc_files = ["README.rdoc", "LICENSE", 'NOTICE'] 22 | s.summary = SUMMARY 23 | s.description = s.summary 24 | s.author = AUTHOR 25 | s.email = EMAIL 26 | s.homepage = HOMEPAGE 27 | 28 | # Uncomment this to add a dependency 29 | # s.add_dependency "foo" 30 | 31 | s.require_path = 'lib' 32 | s.autorequire = GEM 33 | s.files = %w(LICENSE README.rdoc Rakefile NOTICE) + Dir.glob("{lib,spec,features}/**/*") 34 | end 35 | 36 | task :default => :test 37 | 38 | desc "Run specs" 39 | Spec::Rake::SpecTask.new do |t| 40 | t.spec_files = FileList['spec/**/*_spec.rb'] 41 | t.spec_opts = %w(-fs --color) 42 | end 43 | 44 | Rake::GemPackageTask.new(spec) do |pkg| 45 | pkg.gem_spec = spec 46 | end 47 | 48 | desc "install the gem locally" 49 | task :install => [:package] do 50 | sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}} 51 | end 52 | 53 | desc "create a gemspec file" 54 | task :make_spec do 55 | File.open("#{GEM}.gemspec", "w") do |file| 56 | file.puts spec.to_ruby 57 | end 58 | end 59 | 60 | Cucumber::Rake::Task.new(:features) do |t| 61 | t.step_pattern = 'features/steps/**/*.rb' 62 | supportdir = 'features/support' 63 | t.cucumber_opts = "--format pretty -r #{supportdir}" 64 | end 65 | 66 | desc "Run the spec and features" 67 | task :test => [ :features, :spec ] -------------------------------------------------------------------------------- /spec/mixlib/config_spec.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Author:: Adam Jacob () 3 | # Copyright:: Copyright (c) 2008 Opscode, Inc. 4 | # License:: Apache License, Version 2.0 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper")) 20 | 21 | describe Mixlib::Config do 22 | before(:each) do 23 | ConfigIt.configure do |c| 24 | c[:alpha] = 'omega' 25 | c[:foo] = nil 26 | end 27 | end 28 | 29 | it "should load a config file" do 30 | File.stub!(:exists?).and_return(true) 31 | File.stub!(:readable?).and_return(true) 32 | IO.stub!(:read).with('config.rb').and_return("alpha = 'omega'\nfoo = 'bar'") 33 | lambda { 34 | ConfigIt.from_file('config.rb') 35 | }.should_not raise_error 36 | end 37 | 38 | it "should raise an ArgumentError with an explanation if you try and set a non-existent variable" do 39 | lambda { 40 | ConfigIt[:foobar] 41 | }.should raise_error(ArgumentError) 42 | end 43 | 44 | it "should raise an IOError if it can't find the file" do 45 | lambda { 46 | ConfigIt.from_file("/tmp/timmytimmytimmy") 47 | }.should raise_error(IOError) 48 | end 49 | 50 | it "should allow you to reference a value by index" do 51 | ConfigIt[:alpha].should == 'omega' 52 | end 53 | 54 | it "should allow you to set a value by index" do 55 | ConfigIt[:alpha] = "one" 56 | ConfigIt[:alpha].should == "one" 57 | end 58 | 59 | it "should allow you to set config values with a block" do 60 | ConfigIt.configure do |c| 61 | c[:cookbook_path] = "monkey_rabbit" 62 | c[:otherthing] = "boo" 63 | end 64 | ConfigIt.cookbook_path.should == "monkey_rabbit" 65 | ConfigIt.otherthing.should == "boo" 66 | end 67 | 68 | it "should raise an ArgumentError if you access a config option that does not exist" do 69 | lambda { ConfigIt[:snob_hobbery] }.should raise_error(ArgumentError) 70 | end 71 | 72 | it "should return true or false with has_key?" do 73 | ConfigIt.has_key?(:monkey).should eql(false) 74 | ConfigIt[:monkey] = "gotcha" 75 | ConfigIt.has_key?(:monkey).should eql(true) 76 | end 77 | 78 | end -------------------------------------------------------------------------------- /lib/mixlib/config.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Author:: Adam Jacob () 3 | # Copyright:: Copyright (c) 2008 Opscode, Inc. 4 | # License:: Apache License, Version 2.0 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | module Mixlib 20 | module Config 21 | 22 | @@configuration = Hash.new 23 | 24 | # Loads a given ruby file, and runs instance_eval against it in the context of the current 25 | # object. 26 | # 27 | # Raises an IOError if the file cannot be found, or is not readable. 28 | # 29 | # === Parameters 30 | # :: A filename to read from 31 | def from_file(filename) 32 | if File.exists?(filename) && File.readable?(filename) 33 | self.instance_eval(IO.read(filename), filename, 1) 34 | else 35 | raise IOError, "Cannot open or read #{filename}!" 36 | end 37 | end 38 | 39 | # Pass Mixlib::Config.configure() a block, and it will yield @configuration. 40 | # 41 | # === Parameters 42 | # :: A block that takes @configure as it's argument 43 | def configure(&block) 44 | block.call(@@configuration) 45 | end 46 | 47 | # Get the value of a configuration option 48 | # 49 | # === Parameters 50 | # config_option:: The configuration option to return 51 | # 52 | # === Returns 53 | # value:: The value of the configuration option 54 | # 55 | # === Raises 56 | # :: If the configuration option does not exist 57 | def [](config_option) 58 | if @@configuration.has_key?(config_option.to_sym) 59 | @@configuration[config_option.to_sym] 60 | else 61 | raise ArgumentError, "Cannot find configuration option #{config_option.to_s}" 62 | end 63 | end 64 | 65 | # Set the value of a configuration option 66 | # 67 | # === Parameters 68 | # config_option:: The configuration option to set (within the []) 69 | # value:: The value for the configuration option 70 | # 71 | # === Returns 72 | # value:: The new value of the configuration option 73 | def []=(config_option, value) 74 | @@configuration[config_option.to_sym] = value 75 | end 76 | 77 | # Check if Mixlib::Config has a configuration option. 78 | # 79 | # === Parameters 80 | # key:: The configuration option to check for 81 | # 82 | # === Returns 83 | # :: If the configuration option exists 84 | # :: If the configuration option does not exist 85 | def has_key?(key) 86 | @@configuration.has_key?(key.to_sym) 87 | end 88 | 89 | # Allows for simple lookups and setting of configuration options via method calls 90 | # on Mixlib::Config. If there any arguments to the method, they are used to set 91 | # the value of the configuration option. Otherwise, it's a simple get operation. 92 | # 93 | # === Parameters 94 | # method_symbol:: The method called. Must match a configuration option. 95 | # *args:: Any arguments passed to the method 96 | # 97 | # === Returns 98 | # value:: The value of the configuration option. 99 | # 100 | # === Raises 101 | # :: If the method_symbol does not match a configuration option. 102 | def method_missing(method_symbol, *args) 103 | num_args = args.length 104 | 105 | # If we have the symbol, or if we need to set it 106 | if @@configuration.has_key?(method_symbol) || num_args > 0 107 | if num_args > 0 108 | @@configuration[method_symbol] = num_args == 1 ? args[0] : args 109 | end 110 | return @@configuration[method_symbol] 111 | else 112 | # Otherwise, we're just looking it up 113 | raise ArgumentError, "Cannot find configuration option #{method_symbol.to_s}" 114 | end 115 | end 116 | 117 | end 118 | end 119 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------