conjuror 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0aa02f3cede8bfff756c334f16221bc9201156cf
+  data.tar.gz: 9117723bfe0d7f5f56006c880014457f899ee052
+SHA512:
+  metadata.gz: a31d33259b0beb8b739339c880c3dfa7de39a0933c1c4c5b23460f21520fcdc33250834b65d62c4dbc71d5dc91256177eb110349ae213d6b1fc003604e6a2245
+  data.tar.gz: f6a29d64b9db00fc53793b9c88fda9fca8fd0287e8c7401f2b8724c140f1d3a12e6657e14b5a520b9e2fa3d53bc76f3c9316f5826a6647b6844fa00fe1c8540b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - 1.8.7
+  - ruby-head
+  - jruby-18mode
+  - jruby-19mode
+  - jruby-head
+  - ree

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in conjuror.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nikhil Gupta
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# Conjuror
+
+Easily conjure configuration settings for your standalone ruby applications.
+`Conjuror` creates configuration file for projects at a centralized place in the
+user's home directory, and allow each project to have a unique and separate
+configuration directory of itself.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'conjuror'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install conjuror
+
+## Usage
+
+Let's say, that you are developing a gem with the name `awesome`, and you want
+a configuration file for that project, well, you can do something like:
+
+	settings = Conjuror.new "awesome", "filename"
+	settings["opt"] = "value" # setting an option saves the file automatically
+	settings.path #=> ~/.conjuror/awesome/filename.yml
+	
+The above will create the `~/.conjuror/awesome` directory for you, along with
+your configuration file (named `filename.yml`) for you. Second argument is
+optional, and will create a file named `conf.yml` if you do not specify it.
+
+Now, `Conjuror` uses the first file specified in the `initializer` as the
+default, and starts with it. To create a new setting, you can do:
+
+	settings["option"] = "value"       # saved instantly to the YAML config file
+	settings["option"] #=> value       # easily access your settings
+	settings.option	   #=> value       # allows access using 'dot' syntax
+
+Note that, settings are persisted to the local configuration file on disk nearly
+instantly.
+
+You are, also, able to switch to different projects or configuration files,
+easily like this:
+
+	settings.use "anotherproject"       # switch to 'anotherproject#conf'
+	settings.use "awesome", "filename"  # switch to 'awesome#filename'
+	settings.file = 'configuration'     # switch to 'awesome#configuration'
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/conjuror.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'conjuror/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "conjuror"
+  spec.version       = Conjuror::VERSION
+  spec.authors       = ["Nikhil Gupta"]
+  spec.email         = ["me@nikhgupta.com"]
+  spec.description   = %q{Easy Configuration for Standalone Ruby Scripts.}
+  spec.summary       = %q{Easy Configuration for Standalone Ruby Scripts.}
+  spec.homepage      = "http://github.com/nikhgupta/conjuror"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/conjuror/settings.rb

@@ -0,0 +1,72 @@
+module Conjuror
+  class Settings
+
+    include Singleton
+
+    attr_reader :name, :file, :data
+
+    # Returns an instance of the class itself.
+    #
+    def use name = nil, file = nil
+      self.name = name
+      self.file = file
+      self
+    end
+
+    def file= file
+      @file = (file ? file.to_s : "conf")
+      @data = (YAML.load_file(self.path) rescue {})
+    end
+
+    def path
+      raise Conjuror::NoConfigurationLoadedError unless @name && @file
+      File.join(self.directory, @file + ".yml")
+    end
+
+    # def reload
+    #   self.use @name, @file
+    # end
+
+    def [] key
+      @data[key]
+    end
+
+    # ensures that every new setting is first persisted to the file.
+    def []= key, value
+      @data[key] = value
+      save_configuration
+      value
+    end
+
+    def directory
+      self.class.directory_for(@name)
+    end
+
+    def method_missing *args
+      return @data[args.first.to_s] if @data && config_defined?(args.first.to_s)
+      return @data[args.first.to_sym] if @data && config_defined?(args.first.to_sym)
+      raise NoMethodError, "Found no such method."
+    end
+
+    def self.directory_for(name)
+      File.join(ENV['HOME'], ".conjuror", name.to_s.gsub(/^\.+/, ''))
+    end
+
+    private
+
+    def name= name
+      @name = name
+      FileUtils.mkdir_p self.directory unless File.directory? self.directory
+    end
+
+    def save_configuration
+      File.open(self.path, "w") { |f| f.puts @data.to_yaml }
+      @data
+    end
+
+    def config_defined? key
+      @data.has_key? key
+    end
+
+  end
+end

data/lib/conjuror/version.rb

@@ -0,0 +1,3 @@
+module Conjuror
+  VERSION = "0.1.0"
+end

data/lib/conjuror.rb

@@ -0,0 +1,19 @@
+require 'yaml'
+require 'fileutils'
+require 'singleton'
+require 'rubygems'
+require "conjuror/version"
+require "conjuror/settings"
+
+module Conjuror
+
+  class NoConfigurationLoadedError < StandardError
+    def initialize message = "You must call 'use' to load the appropriate configuration."
+      super
+    end
+  end
+
+  def self.new name = nil, file = nil
+    Settings.instance.use name, file
+  end
+end

data/spec/conjuror_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+describe Conjuror do
+
+  before(:each) do
+    [ "conjuror", "randomname" ].each do |name|
+      FileUtils.rm_rf Conjuror::Settings.directory_for(name)
+    end
+  end
+
+  it 'has a version number' do
+    expect(Conjuror::VERSION).not_to be_nil
+  end
+
+  describe "#new" do
+    subject { Conjuror.new }
+
+    it 'creates an instance of Settings class' do
+      result = subject.is_a?(Conjuror::Settings)
+      expect(result).to be_true
+    end
+
+    it 'does not create another instance of itself' do
+      result = subject === Conjuror.new
+      expect(result).to be_true
+    end
+  end
+end
+
+describe Conjuror::Settings do
+
+  before(:each) do
+    [ "conjuror", "randomname" ].each do |name|
+      FileUtils.rm_rf Conjuror::Settings.directory_for(name)
+    end
+    Singleton.__init__(Conjuror::Settings)
+  end
+
+  subject(:settings) { Conjuror::Settings.instance }
+
+  describe "#new" do
+    it 'raises an error when an attempt to create an instance is made' do
+      expect { Conjuror::Settings.new }.to raise_error(NoMethodError)
+    end
+  end
+
+  describe "#path" do
+    it 'raises an error when configuration was accessed but not loaded' do
+      expect { settings.path }.to raise_error
+    end
+  end
+
+  describe "#use" do
+    it 'creates a configuration directory when properly loaded' do
+      directory = settings.use("conjuror").directory
+
+      expect(File.basename(directory)).to eq("conjuror")
+      expect(directory).to eq(File.expand_path("~/.conjuror/conjuror"))
+      expect(File.directory?(directory)).to be_true
+    end
+
+    it 'chooses a default configuration file if none specified' do
+      settings.use("conjuror")
+      settings["option"] = "value" # triggers the saving of config file
+
+      expect(settings.file).to eq("conf")
+      expect(File.file?(settings.path)).to be_true
+    end
+
+    it "returns an instance of itself" do
+      result = settings.use("conjuror") === settings
+      expect(result).to be_true
+    end
+  end
+
+  describe "#[], #[]=" do
+    it "allows easy access and creation of new settings" do
+      settings.use("conjuror")
+      expect(settings["option"]).to be_nil
+
+      settings["option"] = "value"
+      expect(settings["option"]).to eq("value")
+      expect(settings.option).to eq("value")
+    end
+
+    it 'saves the new settings to the disk' do
+      settings.use("conjuror")
+      settings["option"] = "value"
+
+      result = YAML.load_file(settings.path)["option"]
+      expect(result).to eq("value")
+    end
+  end
+
+  describe "#file=" do
+    it "allows switching to a different configuration files and projects" do
+      settings.use "conjuror"                   # use: conjuror, conf
+      settings["option"] = "value1"
+      settings.file = "otherfile"               # use: conjuror, otherfile
+      settings["option"] = "value2"
+
+      settings.use "randomname"                 # use: randomname, conf
+      settings["option"] = "value3"
+      settings.file = "otherfile"               # use: randomname, otherfile
+      settings["option"] = "value4"
+
+      settings.file = "conf"                    # use: randomname, "conf"
+      expect(settings.option).to eq("value3")
+
+      settings.use "conjuror", "otherfile"      # use: conjuror, otherfile
+      expect(settings.option).to eq("value2")
+
+      settings.file = nil                       # use: conjuror, "conf"
+      expect(settings.option).to eq("value1")
+
+      settings.use "randomname", "otherfile"      # use: randomname, otherfile
+      expect(settings.option).to eq("value4")
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'conjuror'

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: conjuror
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nikhil Gupta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easy Configuration for Standalone Ruby Scripts.
+email:
+- me@nikhgupta.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- conjuror.gemspec
+- lib/conjuror.rb
+- lib/conjuror/settings.rb
+- lib/conjuror/version.rb
+- spec/conjuror_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/nikhgupta/conjuror
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Easy Configuration for Standalone Ruby Scripts.
+test_files:
+- spec/conjuror_spec.rb
+- spec/spec_helper.rb