templar 0.7.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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,192 @@
+Templar
+=======
+
+[Config] **Templar** provides the ability to manage development configurations for any file in a project, using ERB templates.
+
+Usage
+-----
+
+Once **Templar** is installed and configured, it will automatically keep your local copies of configurations up-to-date. It
+does this by running prior to initialization of the Rails environment.
+
+The *Example* section below, will give you the best idea of the usage of **Templar**.
+
+Example
+-------
+
+Most of this example is now handled by `rake templar:file[filename]`.
+
+This will take you, step by step, through the process of configuring and using **Templar** to manage the database.yml file
+in a Rails application.
+
+Before we begin, please follow the instructions in the *Installation* section below.
+
+### the `database.yml` file
+
+```ruby
+development:
+  adapter:  mysql
+  database: name_development
+  user:
+  username: root
+  password:
+production:
+  ...
+```
+
+### `git mv` the `database.yml` file
+
+Move the file from it's normal location to the templar directory and add the `erb` extension.
+
+```
+git mv config/database.yml config/templar/database.yml.erb
+```
+
+### add `config/database.yml` to `.gitignore`
+
+This means you will track the template, but not the output file.
+
+```
+echo "config/database.yml" > .gitignore
+```
+
+### add file to `templar.yml` config
+
+edit the `config/templar.yml` file and add an entry to the `templates` section for `database.yml`
+
+```yaml
+templates:
+  ...
+  - { file: database.yml.erb,     dest: config/database.yml }
+```
+
+### copy the configuration info from the `database.yml`
+
+Copy and paste the configuration information from `config/templar/database.yml.erb` to `templar/data.yml`
+
+```yaml
+# database.yml
+database:
+  adapter: mysql
+  database: name_development
+  username: root
+  password:
+  host: 127.0.0.1
+```
+
+### change the `database.yml.erb` file
+
+Change the values in the `config/templar/database.yml.erb` file to use the template variables.
+
+The configuration values from the `config/templar/data.yml` file are available in the @T template variable.
+
+```yaml
+development:
+  adapter:  <%= @T.database.adapter %>
+  database: <%= @T.database.database %>
+  user:     <%= @T.database.user %>
+  username: <%= @T.database.username %>
+  password: <%= @T.database.password %>
+production:
+  ...
+```
+
+### done
+
+The `database.yml` is now managed by **Templar**. I'm hoping that this entire process will be simplified with a rake task.
+
+Installation
+------------
+
+Add the gem into the Gemfile.
+
+### Gemfile
+
+```ruby
+gem 'templar'
+```
+
+Then run `bundle install`
+
+### config/environment.rb
+
+Add the following line to this file:
+
+```ruby
+Templar.init()
+```
+
+### The `templarize` command
+
+Similar to `capify` or `wheneverize` this command will add the basic configuration files for **Templar** to your
+rails application directory.
+
+From within the rails base directory, run the command `templarize .` You must specify the `.` as part of the command.
+
+Once the command is complete, it will have created three new files `config/templar/data.yml`, `config/templar/data.sample.yml` and `config/templar.yml`.
+It will also have added some lines to the `.gitignore` file.
+
+Confguration
+------------
+
+There are two configuration files for **Templar**.
+
+### config/templar.yml
+
+The `templar.yml` file is the primary configuration for **Templar**. Most often, you will only need to change the
+`templates` section of this file.
+
+```yaml
+# templates: the list of files and destinations to be handled by **Templar**
+templates:
+  # example
+  #- {file: randomconfig.yml.erb, dest: config/randomconfig.yml}
+
+# default options
+# you generally will not need to change these options
+
+# directory: the directory containing the templated configuration files (erb) and the data file
+directory: config/templar
+
+# always_update: force the template files to be regenerated everytime
+# default: false. The files will only be regenerated when the erb template is newer than the destination file
+always_update: false
+
+# the file containing the data used in the templates
+# default: data.yml (relative to the "directory" configuration value)
+data_file: data.yml
+```
+
+### config/templar/data.sample.yml
+
+This file should contain the default local development environment configuration data. This is used to create the
+`config/templar/data.yml` file for users when they first setup their local development environment for the app.
+
+### config/templar/data.yml
+
+This file is ignored by git automatically (as part of the installation process). This should contain the configuration
+for the local development environment.
+
+An example `data.yml`.
+
+```yaml
+# database.yml
+database:
+  adapter: mysql
+  database: name_development
+  username: root
+  password:
+  host: 127.0.0.1
+```
+
+This file contains any of the data that will be inserted into the template configuration files. Such that if you have a
+`database.yml.erb` file managed by **Templar**, you can populate the data from the database block in the `data.yml` file.
+
+See *Example* for more info.
+
+TODO
+----
+
+### Clean up Capistrano integration
+
+Still needs a bit of help.

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Templar'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/bin/templarize

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+# shamelessly stolen from "capify" script
+
+require 'optparse'
+require 'fileutils'
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [path]"
+
+  opts.on("-h", "--help", "Displays this help info") do
+    puts opts
+    exit 0
+  end
+
+  begin
+    opts.parse!(ARGV)
+  rescue OptionParser::ParseError => e
+    warn e.message
+    puts opts
+    exit 1
+  end
+end
+
+if ARGV.empty?
+  abort "Please specify the directory to templarize, e.g. `#{File.basename($0)} .'"
+elsif !File.exists?(ARGV.first)
+  abort "`#{ARGV.first}' does not exist."
+elsif !File.directory?(ARGV.first)
+  abort "`#{ARGV.first}' is not a directory."
+elsif ARGV.length > 1
+  abort "Too many arguments; please specify only the directory to capify."
+end
+
+def unindent(string)
+  indentation = string[/\A\s*/]
+  string.strip.gsub(/^#{indentation}/, "")
+end
+
+files = {
+  "config/templar.yml" =>
+      File.open(File.expand_path("../config/templar.sample.yml", File.dirname(__FILE__))).read,
+  "config/templar/data.sample.yml" =>
+      File.open(File.expand_path("../config/templar/data.sample.yml", File.dirname(__FILE__))).read,
+  "config/templar/data.yml" =>
+      File.open(File.expand_path("../config/templar/data.sample.yml", File.dirname(__FILE__))).read
+}
+
+base = ARGV.shift
+files.each do |file, content|
+  file = File.join(base, file)
+  if File.exists?(file)
+    warn "[skip] '#{file}' already exists"
+  elsif File.exists?(file.downcase)
+    warn "[skip] '#{file.downcase}' exists, which could conflict with `#{file}'"
+  else
+    unless File.exists?(File.dirname(file))
+      puts "[add] making directory '#{File.dirname(file)}'"
+      FileUtils.mkdir(File.dirname(file))
+    end
+    puts "[add] writing '#{file}'"
+    File.open(file, "w") { |f| f.write(content) }
+  end
+end
+
+gitignore = File.join(base, ".gitignore")
+if File.exists?(gitignore)
+  puts "[append] #{gitignore}"
+  File.open(gitignore, "a") {|f| f.puts "\n#### Added by templarize script (Templar)\nconfig/templar/data.yml\n"}
+end
+
+puts "[done] templarized!"

data/config/templar.sample.yml

@@ -0,0 +1,19 @@
+
+# templates: the list of files and destinations to be handled by Templar
+templates:
+  # example
+  #- {file: randomconfig.yml.erb, dest: config/randomconfig.yml}
+
+# default options
+# you generally will not need to change these options
+
+# directory: the directory containing the templated configuration files (erb) and the data file
+directory: config/templar
+
+# always_update: force the template files to be regenerated everytime
+# default: false. The files will only be regenerated when the erb template is newer than the destination file
+always_update: false
+
+# the file containing the data used in the templates
+# default: data.yml (relative to the "directory" configuration value)
+data_file: data.yml

data/lib/rails/init.rb

@@ -0,0 +1 @@
+require 'templar'

data/lib/tasks/templar_tasks.rake

@@ -0,0 +1,33 @@
+require 'templar'
+
+namespace :templar do
+  task :update do
+    templar = Templar::Processor.new({"always_update" => true})
+  end
+
+  desc "use templar to manage file"
+  task :file, [:filename] => :environment do |t, args|
+    dir    = Templar.config.directory
+    source = args[:filename]
+    file   = File.basename(source)
+    dest   = "#{dir}/#{file}.erb"
+
+    puts "[move] #{source} -> #{dest}"
+    FileUtils.move(source, dest)
+
+    puts "[ignore] #{source}"
+    gitignore = File.join(".gitignore")
+    if File.exists?(gitignore)
+      puts "[append] #{gitignore}"
+      File.open(gitignore, "a") {|f| f.puts "\n#### Added by 'rake templar:file'\n#{source}\n"}
+    end
+
+    puts "[template] #{dest}"
+    config = YAML.load_file('config/templar.yml')
+    config["templates"] ||= []
+    config["templates"] << {'file' => "#{file}.erb", 'dest' => source}
+    File.open('config/templar.yml', 'w') do |out|
+      YAML.dump(config, out)
+    end
+  end
+end

data/lib/templar.rb

@@ -0,0 +1,5 @@
+require 'templar/version'
+require 'templar/config'
+require 'templar/processor'
+require 'templar/exceptions'
+require 'templar/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3

data/lib/templar/capistrano.rb

@@ -0,0 +1,35 @@
+require 'templar'
+require 'awesome_print'
+
+configuration = Capistrano::Configuration.respond_to?(:instance) ?
+    Capistrano::Configuration.instance(:must_exist) :
+    Capistrano.configuration(:must_exist)
+
+configuration.load do
+
+  puts "  * initializing templar..."
+
+  @templar = Templar::Processor.new
+  @templar.config.environment = ARGV[0] if @templar.config.use_environments
+  @templar.config.print_format = "    templar: (update: %s) %s => %s"
+
+  begin
+    [ARGV[0], ARGV[1]].each do |arg|
+      task arg do
+        nil
+      end
+    end
+  rescue
+    nil
+  end
+
+  def run_templar(opts={})
+    @templar.process
+  end
+
+  task :templar, :once => true do
+    # force updates if we're called directly
+    @templar.config.always_update = true
+    run_templar
+  end
+end

data/lib/templar/config.rb

@@ -0,0 +1,42 @@
+# stolen from mjijackson
+# http://mjijackson.com/2010/02/flexible-ruby-config-objects
+
+module Templar
+  class Config
+    def initialize(data={ })
+      @data = { }
+      update!(data)
+    end
+
+    def update!(data)
+      data.each do |key, value|
+        self[key] = value
+      end
+    end
+
+    def [](key)
+      @data[key.to_sym]
+    end
+
+    def []=(key, value)
+      if value.class == Hash
+        @data[key.to_sym] = Config.new(value)
+      elsif value.class == Array
+        @data[key.to_sym] = []
+        value.each do |v|
+          @data[key.to_sym] << Config.new(v)
+        end
+      else
+        @data[key.to_sym] = value
+      end
+    end
+
+    def method_missing(sym, *args)
+      if sym.to_s =~ /(.+)=$/
+        self[$1] = args.first
+      else
+        self[sym]
+      end
+    end
+  end
+end