motion-config-vars 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 03fe7e08ee3986a30b83bd0a5d7cef39b14587ad
+  data.tar.gz: 62e331e8b0e041b67e5085edd70e8f5c9fd3676a
+SHA512:
+  metadata.gz: 338a73be0ad0581aa2b25663c3675f2cdd14fe23cd2b815cec3eb7e7604a1748b3fd8e6df720b3dc59b955c607d060ee4f34025ec37b1aa43545023f928161f5
+  data.tar.gz: 7bc6b0f6ba6d9160e29407673b45cf88fa2efeab986fa2fde7a686e94a4886908135c5363c5fb5b96b57988cacb02c9d67d211b8b4c3b4a051a2cfd1be6c69e1

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# RM-specific additions
+.repl_history
+build
+tags
+app/pixate_code.rb
+resources/*.nib
+resources/*.momd
+resources/*.storyboardc
+.DS_Store
+nbproject
+.redcar
+#*#
+*~
+*.sw[po]
+.eprj
+.sass-cache
+.idea

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brent Hargrave
+
+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,109 @@
+# motion-config-vars
+## Configure RubyMotion's ENV with a YAML file
+
+This gem brings Rails-on-Heroku-style environment configuration to Rubymotion
+development. Fill out a YAML configuration file with top-level keys containing
+mutually-exclusive environments, and nest keys below them with values
+specific to each environment configuration.
+
+For example, setting up an env.yml like so...
+```yaml
+API_ENV:
+  development:
+    HOST: "lvh.me:3000"
+  test:
+    HOST: "lvh.me:3001"
+  production:
+    HOST: "domain.com"
+```
+
+...and then passing a value for your top-level key, like so:
+```bash
+rake archive API_ENV=development
+```
+
+...exposes the following in both RM's rake tasks *and* the app's runtime:
+```ruby
+ENV["API_ENV"] #=> development
+ENV["HOST"] #=> lvh.me:3000
+```
+
+If touching ENV makes you queasy, not to worry. Pre-existing values aren't
+overwritten and an alternative hash-like constant, RMENV, is configured as well.
+
+You might ask why not make "development", "production", etc. the top-level
+keys? Why bother requiring an API_ENV? In my experience configuring environements
+for API-backed clients is more complex because their configs depend on both the
+build style (for example, "development", "adhoc" or "release") *and* the API
+they are backed by ("development", "staging", "production"). Using these
+"facets" for top-level keys enables much more flexible configuration.
+
+For example, you could expand the above app.yml with...
+```yaml
+AUDIENCE_ENV:
+- developer
+- adhoc
+- release
+```
+
+...and then easily point a dev build at your production API
+```bash
+rake device API_ENV=production AUDIENCE_ENV=developer
+```
+...or restrict new features to beta-testers, but only beta-testers:
+```bash
+rake device API_ENV=production AUDIENCE_ENV=adhoc
+```
+
+
+## Install
+
+Add it to your app's Gemfile:
+
+    gem 'motion-config-vars'
+
+Require it in the app's Rakefile:
+
+    require 'motion-config-vars'
+
+Generate the sample YAML config file:
+
+    rake config:vars:init # generates "./resources/app.yml"
+
+
+## Usage, with an IMPORTANT caveat
+
+After generating the "resources/app.yml" and filling it out you're *almost*
+ready to roll. One more detail.
+
+It seems that RM currently monitors changes to your project's Rakefile, and only
+rebuilds your app from the Rakefile's configuration if the file itself has
+been modified since the last build.  While using this gem, however, your app's
+configuration is *dynamically* updated (specifically, the "app.info_plist"
+configuration variable is edited), which RM won't pick up by default. So, to
+ensure RM rebuilds from the latest, dynamically-defined values in your Rakefile
+it will automatically [touch](http://en.wikipedia.org/wiki/Touch_(Unix)) your
+project's Rakefile before any of RM's default, build-triggering tasks.
+
+Git won't care, but you might: use of this gem may increase your project's
+average build time. The tradeoff for cleaner configuration has been more than
+worthwhile for me, but YMMV.
+
+
+## Tests
+
+To run the tests, run
+```bash
+touch Rakefile; bundle exec rake spec BUILD_ENV=test
+```
+(The gem only embeds its code in the app if a config file is present, so it's
+necessary to include a test app.yml to ensure the specs have code to exercise.)
+
+
+## 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,11 @@
+# -*- coding: utf-8 -*-
+require "bundler/gem_tasks"
+$:.unshift("/Library/RubyMotion/lib")
+require 'motion/project'
+require 'rubygems'
+require './lib/motion-config-vars'
+
+Motion::Project::App.setup do |app|
+  app.name = 'motion-config-vars'
+end
+

data/app/app_delegate.rb

@@ -0,0 +1,5 @@
+class AppDelegate
+  def application(application, didFinishLaunchingWithOptions:launchOptions)
+    true
+  end
+end

data/lib/motion-config-vars.rb

@@ -0,0 +1,76 @@
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+vars_yml_filename = "app.yml"
+vars_yml_path = "resources/#{vars_yml_filename}"
+
+namespace "config:vars" do
+  desc "Generate starter #{vars_yml_filename}, append it to your .gitignore"
+  task :init do
+    # write out the file
+    template_filepath = File.join(File.dirname(File.realdirpath(__FILE__)),
+                                  "/motion-config-vars/templates/#{vars_yml_filename}")
+    content = File.read template_filepath
+    if File.exists? vars_yml_path
+      puts "ERROR: file already exists #{vars_yml_path}"
+    else
+      puts "writing #{vars_yml_path}"
+      puts content
+      File.open(vars_yml_path, "w") { |file| file.write content }
+    end
+    # append filepath to project's .gitignore
+    if File.exists? '.gitignore'
+      File.open('.gitignore', "a") do |file|
+        file.puts "\n# Ignore motion-config-vars config file\n#{vars_yml_path}"
+      end
+    end
+  end
+end
+
+
+require 'rake/hooks'
+
+before *%w{ spec
+            config
+            default
+            build build:device build:simulator
+            archive archive:distribution } do
+
+  unless File.exists? vars_yml_path
+    puts "WARNING: '#{vars_yml_path}' missing. Run 'rake config:vars:init' to generate one."
+  else
+
+    # NOTE: RM appears to monitor a project Rakefile's modified-at timestamp,
+    # so we force-update it before every build to ensure the build reflects
+    # the latest passed-in environment variable(s).
+    `touch Rakefile`
+
+    require 'yaml' # TODO: how to exclude from build?
+    require 'motion-yaml'
+
+    Motion::Project::App.setup do |app|
+      vars_yaml = File.read vars_yml_path
+      vars_data = YAML.load vars_yaml
+
+      %w{ configuration_error hashlike_object_configurer }.each do |filename|
+        require File.join(File.dirname(__FILE__), "motion-config-vars/embed/#{filename}")
+      end
+      MotionConfigVars::HashlikeObjectConfigurer.new({
+        config_vars_data: vars_data,
+        hashlike_object: app.info_plist,
+        config_name_for_facet_named: lambda { |facet_name| ENV[facet_name] }
+      }).perform!
+
+      # once app.info_plist successfully configured, insert code necessary to
+      # configure app's ENV as well.
+      Dir.glob(File.join(File.dirname(__FILE__), 'motion-config-vars/embed/*.rb')).each do |file|
+        app.files.unshift file
+      end
+
+    end
+
+  end
+
+end
+

data/lib/motion-config-vars/embed/config_vars_loader.rb

@@ -0,0 +1,19 @@
+if path = NSBundle.mainBundle.pathForResource("app", ofType:"yml")
+
+  vars_data = YAML.load File.read path
+
+  RMENV = {} # alternative to ENV for the squimish
+  [ENV, RMENV].each do |env|
+    MotionConfigVars::HashlikeObjectConfigurer.new({
+      config_vars_data: vars_data,
+      hashlike_object: env,
+      config_name_for_facet_named: lambda { |facet_name|
+        NSBundle.mainBundle.objectForInfoDictionaryKey facet_name
+      }
+    }).perform!
+  end
+
+else
+  puts "WARNING! main bundle missing app.yml"
+end
+

data/lib/motion-config-vars/embed/configuration_error.rb

@@ -0,0 +1,4 @@
+module MotionConfigVars
+  class ConfigurationError < Exception
+  end
+end

data/lib/motion-config-vars/embed/hashlike_object_configurer.rb

@@ -0,0 +1,86 @@
+module MotionConfigVars
+  class HashlikeObjectConfigurer
+
+    def initialize options={}
+      @hashlike_object = options[:hashlike_object]
+      raise ArgumentError, "'hashlike_object' missing" unless @hashlike_object
+      @config_vars_data = options[:config_vars_data]
+      raise ArgumentError, "'config_vars_data' missing" unless @config_vars_data
+      @config_name_for_facet_named = options[:config_name_for_facet_named]
+      raise ArgumentError, "'config_name_for_facet_named' missing" unless @config_name_for_facet_named
+      self.validate_config_name_for_facet_named_is_closure
+      self.validate_hashlike_object_is_hashlike
+      self.validate_all_configured_facets_are_requested
+      self.validate_all_facets_requested_configurations_available
+    end
+
+    def perform!
+      self.requested_facets_names.each do |requested_facet_name|
+        configuration_name = @config_name_for_facet_named.call requested_facet_name
+        self.set requested_facet_name, configuration_name
+        facet_data = @config_vars_data[requested_facet_name]
+        return unless facet_data.is_a? Hash
+        configuration_data = facet_data[configuration_name]
+        configuration_data.each { |key, value| self.set key, value }
+      end
+    end
+
+  protected
+
+    def set key, value
+      @hashlike_object[key] ||= value
+    end
+
+    def validate_config_name_for_facet_named_is_closure
+      unless @config_name_for_facet_named.respond_to? :call
+        raise ArgumentError, "'config_name_for_facet_named' must be a closure"
+      end
+    end
+
+    def validate_hashlike_object_is_hashlike
+      unless @hashlike_object.respond_to?(:[]=)
+        raise ArgumentError, "hashlike_object must respond to []="
+      end
+    end
+
+    def validate_all_configured_facets_are_requested
+      unless self.all_configured_facets_are_requested?
+        names = self.unrequested_configured_facets_names.join ", "
+        raise ConfigurationError, "configured facet not specified: #{names}"
+      end
+    end
+
+    def all_configured_facets_are_requested?
+      self.configured_facets_names.all? do |facet_name|
+        self.requested_facets_names.include? facet_name
+      end
+    end
+
+    def configured_facets_names
+      @config_vars_data.keys
+    end
+
+    def unrequested_configured_facets_names
+      self.configured_facets_names - requested_facets_names
+    end
+
+    def requested_facets_names
+      self.configured_facets_names.map do |facet_name|
+        facet_name if @config_name_for_facet_named.call(facet_name)
+      end
+    end
+
+    def validate_all_facets_requested_configurations_available
+      self.requested_facets_names.each do |requested_facet_name|
+        configuration_name = @config_name_for_facet_named.call requested_facet_name
+        facet_data = @config_vars_data[requested_facet_name]
+        unless (facet_data.is_a?(Hash) && facet_data[configuration_name]) or
+               (facet_data.is_a?(Array) && facet_data.include?(configuration_name))
+          raise ConfigurationError, "configuration '#{configuration_name}' unavailable for '#{requested_facet_name}'"
+        end
+      end
+    end
+
+  end
+end
+

data/lib/motion-config-vars/templates/app.yml

@@ -0,0 +1,7 @@
+API_ENV:
+  development:
+    HOST: product.dev
+  test:
+    HOST: product.test
+  production:
+    HOST: product.com

data/lib/motion-config-vars/version.rb

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

data/motion-config-vars.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+require File.expand_path('../lib/motion-config-vars/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "motion-config-vars"
+  spec.version       = MotionConfigVars::VERSION
+  spec.authors       = ["Brent Hargrave"]
+  spec.email         = ["brent@brent.is"]
+  spec.description   = %q{Heroku-style config vars for RubyMotion}
+  spec.summary       = %q{Heroku-style config vars for RubyMotion}
+  spec.homepage      = "https://github.com/jamescallmebrent/motion-config-vars"
+  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_dependency('motion-yaml', '>= 1.0')
+  spec.add_dependency('rake-hooks', '~> 1.2.3')
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/resources/app.yml

@@ -0,0 +1,2 @@
+BUILD_ENV:
+- test

data/spec/hashlike_object_configurer_spec.rb

@@ -0,0 +1,126 @@
+describe MotionConfigVars::HashlikeObjectConfigurer do
+
+  before{ @described_class = MotionConfigVars::HashlikeObjectConfigurer }
+
+  shared "a configuration-robust configurer" do
+
+    describe "initialization" do
+
+      it "with valid arguments does not raise exception" do
+        lambda do
+          begin
+            @described_class.new @options
+          rescue => exception
+            puts exception
+          end
+        end.should.not.raise(Exception)
+      end
+
+      [:hashlike_object, :config_vars_data, :config_name_for_facet_named].each do |attr|
+        it "raises ArgumentError without #{attr}" do
+          lambda do
+            @described_class.new @options.tap { |options| options.delete(attr) }
+          end.should.raise(ArgumentError).
+          message.should.eql "'#{attr}' missing"
+        end
+      end
+
+      it "raises ArgumentError if :config_name_for_facet_named isn't a closure" do
+        @options[:config_name_for_facet_named] = "not-a-closure"
+        lambda do
+          @described_class.new @options
+        end.should.raise(ArgumentError).
+        message.should.eql "'config_name_for_facet_named' must be a closure"
+      end
+
+      it "raises ArgumentError if :hashlike_object isn't hashlike" do
+        unhashlike_object = Object.new
+        @options[:hashlike_object] = unhashlike_object
+        lambda do
+          @described_class.new(@options).perform!
+        end.should.raise(ArgumentError).
+        message.should.eql "hashlike_object must respond to []="
+      end
+
+      it "raises ConfigurationError unless all configured facets are specified" do
+        @options[:config_name_for_facet_named] = lambda { |facet_name| {}[facet_name] }
+        lambda do
+          @described_class.new @options
+        end.should.raise(MotionConfigVars::ConfigurationError).
+        message.should.eql "configured facet not specified: API_ENV"
+      end
+
+      it "raises ConfigurationError if specified configuration of any facet unavailable" do
+        @options[:config_vars_data]["API_ENV"].delete "production"
+        lambda do
+          @described_class.new @options
+        end.should.raise(MotionConfigVars::ConfigurationError).
+        message.should.eql "configuration 'production' unavailable for 'API_ENV'"
+      end
+
+    end
+
+    describe "#perform!" do
+
+      before { @described_class.new(@options).perform! }
+
+      it "sets top-level key on hashlike_object" do
+        @hashlike_object["API_ENV"].should.eql "production"
+      end
+
+    end
+
+  end
+
+  describe "provided a standard, hash of hashes configuration structure" do
+
+    before do
+      @hashlike_object = {}
+      @valid_config_vars_data = {
+        "API_ENV" => {
+          "development" =>  { "HOST" => "lvh.me:3000" },
+          "test" =>  { "HOST" => "lvh.me:3001" },
+          "production" =>  { "HOST" => "domain.com" }
+        }
+      }
+      @options = {
+        hashlike_object: @hashlike_object,
+        config_vars_data: @valid_config_vars_data,
+        config_name_for_facet_named: lambda { |facet_name| "production" }
+      }
+    end
+
+    behaves_like "a configuration-robust configurer"
+
+    describe "#perform!" do
+
+      before { @described_class.new(@options).perform! }
+
+      it "also sets configuration key/value pairs" do
+        @hashlike_object["HOST"].should.eql "domain.com"
+      end
+
+    end
+
+  end
+
+  describe "provided an environment-names-array configuration structure" do
+
+    before do
+      @hashlike_object = {}
+      @valid_config_vars_data = {
+        "API_ENV" => %w{ development test production }
+      }
+      @options = {
+        hashlike_object: @hashlike_object,
+        config_vars_data: @valid_config_vars_data,
+        config_name_for_facet_named: lambda { |facet_name| "production" }
+      }
+    end
+
+    behaves_like "a configuration-robust configurer"
+
+  end
+
+end
+

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: motion-config-vars
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brent Hargrave
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: motion-yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+- !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'
+description: Heroku-style config vars for RubyMotion
+email:
+- brent@brent.is
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/app_delegate.rb
+- lib/motion-config-vars.rb
+- lib/motion-config-vars/embed/config_vars_loader.rb
+- lib/motion-config-vars/embed/configuration_error.rb
+- lib/motion-config-vars/embed/hashlike_object_configurer.rb
+- lib/motion-config-vars/templates/app.yml
+- lib/motion-config-vars/version.rb
+- motion-config-vars.gemspec
+- resources/app.yml
+- spec/hashlike_object_configurer_spec.rb
+homepage: https://github.com/jamescallmebrent/motion-config-vars
+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.0
+signing_key: 
+specification_version: 4
+summary: Heroku-style config vars for RubyMotion
+test_files:
+- spec/hashlike_object_configurer_spec.rb