singlettings 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61a5391f730590158f913a9e2b7143fcb9985408
+  data.tar.gz: 20c11138eb0c8873d266b508bf0dc0f35c66e0ab
+SHA512:
+  metadata.gz: aebf3b18a23d2f863e5e9f799da83027e423712afa17dff8e7f6a581eacf76d83b92f19a7d0161366e6c4c287de8a6d87bcb2fb909d0630c9a69ba6625b8d6b1
+  data.tar.gz: f079732f7edb8e2d8d4d9bd47a458377da26c7c4e0c7288abb93e830a94b436f51bdbb7b49b6f856d9b12931dc325049160c90f7e5cb37fb2a916131da6366da

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jingkai He
+
+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,73 @@
+# Singlettings
+
+A simple YML to singleton class solution for ruby programming language. It can be seamless integrated with Rails, Rack, sinatra and any other ruby apps.
+
+It greatly inspired from [Yettings](https://github.com/charlotte-ruby/yettings).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'singlettings', git: "git@github.com:mycolorway/singlettings.git"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install singlettings
+
+## Usage
+
+### Convention Usage for Rails App.
+
+- Create the yaml configuration file named 'singletting.yml' or 'yetting.yml' in 'config' directory. Then you can invoke it by calling ```Singletting.balh_blah_blah``` or ```Yetting.balh_blah_blah```
+
+- Also you can put the configuration files in the 'config/singlettings' directory, the singleton classes will be mechanically generated as described above.
+
+### Convention for other apps, such as rack & sinatra
+
+- Place the configuration files anywhere you want. If the YAML file is named 'Setting', then:
+
+  ```(ruby)
+    class Setting < Singlettings::Base
+      source "#{dir_to_config_file}"
+      ns :your_namespace # Well, a bit clojure flavour...
+    end
+  ```
+
+- Or Just in the lazy way, which will read the setting.yml file in the root directory:
+  ```(ruby)
+    class Setting < Singlettings::Base
+    end
+  ```
+
+- Last but not least, you can use it as an global variable by calling:
+  ```(ruby)
+    SETTING = Singlettings::Base.new("config/settings.yml", "development")
+  ```
+
+### Operations on the Singletting Object
+
+
+You can invoke the object by calling as a hash:
+  ```(ruby)
+    Setting["key1"] # => value1
+    Setting["key1"]["key2"] # => value2
+    Setting[:key1][:key2][:key3] # => value3
+  ```
+
+Also by calling:
+  ```(ruby)
+    Setting.key1 # => value1
+    Setting.key1.key2 # => value2
+  ```
+
+## 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,15 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run an IRB session with Singlettings preloaded"
+task :console do
+  exec "irb -I lib -r singlettings"
+end
+
+desc "Run the test suite"
+RSpec::Core::RakeTask.new(:rspec) do |t|
+  t.pattern = FileList['spec/**/*_spec.rb']
+  t.rspec_opts = %w|--color --format doc|
+end
+
+task default: :spec

data/lib/singlettings.rb

@@ -0,0 +1,5 @@
+module Singlettings
+  require_relative "singlettings/version"
+  require_relative "singlettings/base"
+  require_relative "singlettings/rails"
+end

data/lib/singlettings/base.rb

@@ -0,0 +1,108 @@
+require 'singlettings/exceptions'
+require 'yaml'
+
+require 'erb'
+module Singlettings
+  class Base < Hash
+    attr_reader :source, :ns
+    class << self
+      # Basic Usage of source in class
+      #   source "config/setting.yml"
+      #   source
+      def source(directory = nil)
+        filename = directory ? directory : "#{self.ancestors[0].to_s.downcase}.yml"
+        @erb_content = ERB.new(File.read(filename)).result # Set it in memory
+        @source = @erb_content ? YAML.load(@erb_content) : {}
+      end
+
+      # Set the default namespace
+      # Basic Usage of ns in class:
+      # ns :development
+      # ns Rails.env
+      def ns(value = nil)
+        @ns = value.to_s if value
+      end
+
+      # Override the hash method
+      def [](key)
+        value = current_branch.fetch key.to_s, nil
+        if value.is_a? Hash
+          self.new value
+        else
+          value
+        end
+      end
+
+      def current_branch
+        source unless @source
+        return @source unless @ns
+        if @source[@ns] == nil
+          raise NoSuchNamespaceError, "Source is empty. The namespace does not exist"
+        else
+          @source[@ns]
+        end
+      end
+
+      def method_missing(method, *args, &block)
+        key = method.to_s
+        if current_branch.keys.include? key
+          value = current_branch[key]
+          if value.is_a? Hash
+            self.new value
+          else
+            value
+          end
+        else
+          raise NoSuchKeyError, "#{key} does not exist"
+        end
+      end
+    end # class self
+
+    def initialize(directory_or_hash, default_namespace= nil)
+      @ns = self.class.ns default_namespace
+
+      raise FileNotSpecifiedError, "You should choose a file to initialize" unless directory_or_hash
+
+      if directory_or_hash.is_a? Hash
+        @source = directory_or_hash
+      else
+        @source = self.class.source directory_or_hash
+      end
+
+      self.replace current_branch
+    end
+
+    def current_branch
+      return source unless ns
+      if source[ns] == nil
+        raise NoSuchNamespaceError, "Source is empty. The namespace does not exist"
+      else
+        source[ns]
+      end
+    end
+
+    def [](key)
+      value = current_branch.fetch key.to_s, nil
+      if value.is_a? Hash
+        self.class.new value
+      else
+        value
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      key = method.to_s
+      if current_branch.keys.include? key
+        value = current_branch[key]
+        if value.is_a? Hash
+          self.class.new value
+        else
+          value
+        end
+      else
+        raise NoSuchKeyError, "#{key} does not exist"
+      end
+    end
+  end
+
+end

data/lib/singlettings/exceptions.rb

@@ -0,0 +1,5 @@
+module Singlettings
+  class NoSuchKeyError < StandardError; end
+  class NoSuchNamespaceError < StandardError; end
+  class FileNotSpecifiedError < StandardError; end
+end

data/lib/singlettings/rails.rb

@@ -0,0 +1,56 @@
+require "singlettings/base"
+
+module Singlettings
+  def self.hook_rails!
+    if defined?(::Rails)
+      config_path = "#{::Rails.root.to_s}/config/"
+      Singlettings.load_yaml_files! config_path
+    end
+  end
+
+  class Rails < ::Rails::Engine
+    initializer 'singlettings' do
+      Singlettings.hook_rails!
+    end
+  end if defined?(::Rails)
+
+  private
+  def self.load_yaml_files!(load_path)
+    # Load singletting.yml
+    files = []
+
+    singletting = "#{load_path}singletting.yml"
+    files << singletting if File.exists?(singletting)
+
+    # Add MyColorWay Flavoured yetting.yml
+    yetting = "#{load_path}yetting.yml"
+    files << yetting if File.exists? yetting
+
+    # Add namespaced files
+    files += Dir.glob("#{load_path}singlettings/**/*.yml")
+
+    files.each do |file|
+      Singlettings.eval_yaml file
+    end
+  end
+
+  # This method needs ActiveSupport
+  def self.eval_yaml(file)
+    base_name = File.basename(file).gsub(".yml", "").camelize
+    if base_name == "Singletting" or base_name == "Yetting"
+      klass_name = base_name
+    else
+      klass_name = "Singletting#{base_name}"
+    end
+    Object.const_set(klass_name, Singlettings.eval_yaml_class(file))
+  end
+
+  # Return specified anonymous class
+  def self.eval_yaml_class(file)
+    klass = Class.new(Singlettings::Base) do
+      source file
+      ns ::Rails.env
+    end
+    return klass
+  end
+end

data/lib/singlettings/version.rb

@@ -0,0 +1,3 @@
+module Singlettings
+  VERSION = "0.0.2"
+end

data/myapp/.gitignore

@@ -0,0 +1,16 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/myapp/Gemfile

@@ -0,0 +1,47 @@
+source 'https://rubygems.org'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.0.0'
+
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 4.0.0'
+
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+
+# Use CoffeeScript for .js.coffee assets and views
+gem 'coffee-rails', '~> 4.0.0'
+
+# See https://github.com/sstephenson/execjs#readme for more supported runtimes
+# gem 'therubyracer', platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'
+
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 1.2'
+
+# gem 'singlettings', path: '..'
+gem 'singlettings', path: ".."
+group :doc do
+  # bundle exec rake doc:rails generates the API under doc/api.
+  gem 'sdoc', require: false
+end
+
+# Use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Use Capistrano for deployment
+# gem 'capistrano', group: :development
+
+# Use debugger
+# gem 'debugger', group: [:development, :test]

data/myapp/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/myapp/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Myapp::Application.load_tasks

data/myapp/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .