constantinopolis 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6239ddbd0930e8bff6be617d4f307220d58e0668
+  data.tar.gz: 82e80460a44b89b893fe66eb4913f21c4f9c38bc
+SHA512:
+  metadata.gz: 68c7e8d39bbdb11f77b14dfda21286c5a7eb462ab3ff945c29a37607ea16b1dc828239f5875b942030c4e3f1e28c6162f75422718afe99b274d38ed64f96c868
+  data.tar.gz: 140bbf8fc10a101de88fb5bde9b9eff73f1fecd332c0db306cc17a8ff7a52c3629cdbbd8d642ed99e7f8e4e5fff94641bceace6e051a98b364b0f7f62cb3b38a

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+.DS_Store
+vendor/bundle
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 itmammoth
+
+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,118 @@
+# Constantinopolis
+
+Constantinopolis allows you to set constants from your ERBed YAML file.
+Remarkably, your constants are available not only in ruby context, but in javascript's.
+It works with Rails, Sinatra, or any Ruby projects.
+It's inspired by [settingslogic](https://github.com/binarylogic/settingslogic).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'constantinopolis'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install constantinopolis
+
+## Usage
+
+### Setup your Fort class
+
+You need to create a class in your application like below.
+
+```ruby
+class Istanbul < Constantinopolis::Fort
+  yml "#{Rails.root}/config/istanbul.yml"  # Indicate your yaml file path.
+  namespace Rails.env  # Indicate top level namespace (If you want).
+end
+Istanbul.build!  # Don't forget this line!
+```
+
+If you are setting for rails application, you'd better to create this file in ```config/initializer```.
+
+### Define constants
+
+Secondly, define constant YAML file.
+Of course, you can use ERB expressions in it.
+Top level keys are used for 'namespace' if you indicated it in your Fort class.
+
+```yaml
+defaults: &defaults
+  common: Common value
+
+development:
+  <<: *defaults
+  greeting: Hello, development!
+  number: 1
+  memorable_date: <%= Date.today %>
+  is:
+    located: Turkey
+
+test:
+  <<: *defaults
+  greeting: Hello, test!
+  number: 2
+  memorable_date: <%= Date.today + 1 %>
+  is:
+    located: Turkey
+
+production:
+  <<: *defaults
+  greeting: Hello, production!
+  number: 3
+  memorable_date: <%= Date.today + 2 %>
+  is:
+    located: Turkey
+```
+
+### Access from Ruby
+
+Congratulation!
+you've been already able to access these constants anywhere like below.
+
+```ruby
+Istanbul.common          #=> "Common value"
+Istanbul.greeting        #=> "Hello, development!"
+Istanbul.number          #=> 1
+Istanbul.memorable_date  #=> Wed, 23 Apr 2014
+Istanbul.is.located      #=> Turkey
+```
+
+### Access from Javascript
+
+You can access your constants in javascript the same way as in ruby context.
+Constantinopolis provides you a simple helper method to define javascript's constants.
+
+```html
+<%= javascript_tag Istanbul.js_code %><!-- You need to call this line before using constants. -->
+
+<h1>Javascript context</h1>
+<p id="common"></p>
+<p id="greeting"></p>
+<p id="number"></p>
+<p id="memorable_date"></p>
+<p id="is-located"></p>
+
+<%= javascript_tag do %>
+  document.getElementById("common").innerText = Istanbul.common;
+  document.getElementById("greeting").innerText = Istanbul.greeting;
+  document.getElementById("number").innerText = Istanbul.number;
+  document.getElementById("memorable_date").innerText = Istanbul.memorable_date;
+  document.getElementById("is-located").innerText = Istanbul.is.located;
+<% end %>
+```
+
+It's can be a nice to define ```<%= javascript_tag Istanbul.js_code %>``` in ```layouts/application.html.erb``` if you are developing a rails application.
+
+## Contributing
+
+1. Fork it ( http://github.com/itmammoth/constantinopolis/fork )
+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 @@
+require "bundler/gem_tasks"

data/constantinopolis.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'constantinopolis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "constantinopolis"
+  spec.version       = Constantinopolis::VERSION
+  spec.authors       = ["itmammoth"]
+  spec.email         = ["itmammoth@gmail.com"]
+  spec.summary       = %q{Setting constants solution for ruby applications.}
+  spec.description   = %q{Constantinopolis allows you to set constants from your ERBed YAML file. Remarkably, your constants are available not only in ruby context, but in javascript's. It works with Rails, Sinatra, or any Ruby projects.}
+  spec.homepage      = "https://github.com/itmammoth/constantinopolis"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "rspec", "~> 2.14"
+  spec.add_development_dependency "pry-byebug", "~> 1.3"
+  spec.add_development_dependency "capybara", "~> 2.2"
+  spec.add_development_dependency "launchy", "~> 2.4"
+  spec.add_development_dependency "poltergeist", "~> 1.5"
+  spec.add_development_dependency "sinatra", "~> 1.4"
+end

data/lib/constantinopolis/version.rb

@@ -0,0 +1,3 @@
+module Constantinopolis
+  VERSION = "0.0.1"
+end

data/lib/constantinopolis.rb

@@ -0,0 +1,80 @@
+require "constantinopolis/version"
+require "yaml"
+require "erb"
+require "json"
+
+module Constantinopolis
+
+  class Fort
+    private_class_method :new
+
+    class << self
+
+      def yml(path = nil)
+        @yml ||= path
+      end
+
+      def namespace(namespace = nil)
+        @namespace ||= namespace
+      end
+
+      def build!
+        instance.build_methods!
+        instance.build_js!
+      end
+
+      def js_code
+        instance.js_code
+      end
+
+      private
+
+      def instance
+        return @instance if @instance
+        @instance = new
+      end
+    end
+
+    def build_methods!
+      @constants.each do |key, value|
+        self.class.module_eval do
+          sig = class << self; self; end
+          sig.send :define_method, key, ->() { value }
+        end
+      end
+    end
+
+    def build_js!
+      @js_code = "#{self.class.name}=#{JSON.generate(@constants)};"
+    end
+
+    def js_code
+      @js_code
+    end
+
+    private
+
+    def initialize
+      raise "Must locate yaml file!" unless self.class.yml
+      file = open(self.class.yml).read
+      hash = set_accessor(YAML.load(ERB.new(file).result))
+      @constants = self.class.namespace ? hash[self.class.namespace.to_s] : hash
+    end
+
+    def set_accessor(hash)
+      hash.each do |key, value|
+        if value.is_a? Hash
+          value.extend AccessableHash
+          set_accessor value
+        end
+      end
+    end
+  end
+
+  module AccessableHash
+    def method_missing(name, *args, &block)
+      key = name.to_s
+      self.has_key?(key) ? self[key] : super
+    end
+  end
+end

data/spec/js/constantinopolis_js_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+require 'capybara'
+require 'capybara/rspec'
+require 'capybara/poltergeist'
+require 'sinatra'
+
+Capybara.default_driver = :poltergeist
+Capybara.javascript_driver = :poltergeist
+Capybara.save_and_open_page_path = File.dirname(__FILE__) + '/../tmp'
+
+class SettingRack < Constantinopolis::Fort
+  yml File.expand_path('../setting_rack.yml', __FILE__)
+end
+SettingRack.build!
+
+get '/' do
+  file = open("spec/js/test.html.erb").read
+  erb file
+end
+
+describe 'the dummy app', js: true do
+  include Capybara::DSL
+
+  before do
+    Capybara.app = Sinatra::Application.new
+  end
+
+  it "renders javascript objects" do
+    visit "/"
+    page.should have_content "Fort of javascript"
+    page.should have_content "Hello, world!"
+    page.should have_content "20"
+    page.should have_content "2014-04-23"
+  end
+end

data/spec/js/setting_rack.yml

@@ -0,0 +1,5 @@
+greeting: Hello, world!
+number: 20
+deadline:
+  projects:
+    a: <%= Date.new(2014, 4, 23) %>

data/spec/js/test.html.erb

@@ -0,0 +1,17 @@
+<html>
+<head>
+  <title>spec</title>
+  <script type="text/javascript"><%= SettingRack.js_code %></script>
+</head>
+<body>
+  <h1 id="page-title">Fort of javascript</h1>
+  <p id="greeting"></p>
+  <p id="number"></p>
+  <p id="deadline-projects-a"></p>
+  <script type="text/javascript">
+    document.getElementById("greeting").innerText = SettingRack.greeting;
+    document.getElementById("number").innerText = SettingRack.number;
+    document.getElementById("deadline-projects-a").innerText = SettingRack.deadline.projects.a;
+  </script>
+</body>
+</html>

data/spec/lib/constantinopolis_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Constantinopolis::Fort do
+
+  class NoYaml < Constantinopolis::Fort
+  end
+
+  class WithYaml < Constantinopolis::Fort
+    yml File.expand_path('../setting.yml', __FILE__)
+  end
+  WithYaml.build!
+
+  class WithNamespace < Constantinopolis::Fort
+    yml File.expand_path('../setting_with_namespace.yml', __FILE__)
+    namespace :test
+  end
+  WithNamespace.build!
+
+  describe "::build!" do
+    context "when not located yaml file" do
+      it "raises error" do
+        expect { NoYaml.build! }.to raise_error(RuntimeError, "Must locate yaml file!")
+      end
+    end
+  end
+
+  describe "any keys" do
+    context "when located yaml file" do
+      it { expect(WithYaml.hello).to eq "Hello, CONSTANTINOPOLIS!" }
+      it { expect(WithYaml.number).to eq 10 }
+      it { expect(WithYaml.go.to.hospital).to eq "Go to hospital." }
+    end
+
+    context "when indicated namaespace" do
+      it { expect(WithNamespace.common).to eq "Common value" }
+      it { expect(WithNamespace.hello).to eq "Hello, test!" }
+    end
+  end
+
+  describe "::js_code" do
+    subject(:js_code) { WithYaml.js_code }
+    it { expect(js_code).to match /WithYaml={.*};/m }
+    it { expect(js_code).to match /"hello":"Hello, CONSTANTINOPOLIS!"/m }
+    it { expect(js_code).to match /"number":10/m }
+    it { expect(js_code).to match /"go":{"to":{"hospital":"Go to hospital."}}/m }
+  end
+end

data/spec/lib/setting.yml

@@ -0,0 +1,5 @@
+hello: Hello, <%= "constantinopolis!".upcase %>
+number: 10
+go:
+  to:
+    hospital: "Go to hospital."

data/spec/lib/setting_with_namespace.yml

@@ -0,0 +1,10 @@
+defaults: &defaults
+  common: Common value
+
+development:
+  <<: *defaults
+  hello: "Hello, development!"
+
+test:
+  <<: *defaults
+  hello: "Hello, test!"

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'constantinopolis'
+require 'pry-byebug'
+require 'date'

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: constantinopolis
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- itmammoth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Constantinopolis allows you to set constants from your ERBed YAML file.
+  Remarkably, your constants are available not only in ruby context, but in javascript's.
+  It works with Rails, Sinatra, or any Ruby projects.
+email:
+- itmammoth@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- constantinopolis.gemspec
+- lib/constantinopolis.rb
+- lib/constantinopolis/version.rb
+- spec/js/constantinopolis_js_spec.rb
+- spec/js/setting_rack.yml
+- spec/js/test.html.erb
+- spec/lib/constantinopolis_spec.rb
+- spec/lib/setting.yml
+- spec/lib/setting_with_namespace.yml
+- spec/spec_helper.rb
+homepage: https://github.com/itmammoth/constantinopolis
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Setting constants solution for ruby applications.
+test_files:
+- spec/js/constantinopolis_js_spec.rb
+- spec/js/setting_rack.yml
+- spec/js/test.html.erb
+- spec/lib/constantinopolis_spec.rb
+- spec/lib/setting.yml
+- spec/lib/setting_with_namespace.yml
+- spec/spec_helper.rb