pixii 0.1.0

data/README.md

@@ -0,0 +1,93 @@
+![Pixie](http://github.com/chrislloyd/pixii/raw/master/logo.png)
+
+<small>A mini library for generating files. By [Chris](http://chrislloyd.com.au).</small>
+
+
+If you've ever had to use [Rubigen](http://github.com/drnic/rubigen), then Pixii is for you. Rubigen is waay too complex for what is a _really_ simple problem. Pixii just provides the basics of what you need to generate files and folders.
+
+## Install
+
+    sudo gem install pixii
+
+or
+
+    rip install pixii
+
+## Usage
+
+The best way to learn how to use Pixii is to have a look at [tyrone's Pixii file](http://github.com/chrislloyd/tyrone/tree/master/bin/tyrone):
+
+    Pixii.called(:tyrone) do |make, opts|
+      make.dir 'features', 'mockups', 'public', 'public/js', 'public/images', 'public/css'
+      
+      make.clone 'http://github.com/toolmantim/states.js/raw/master/states.js', 'public/js/states.js'
+      
+      make.template 'sinatra.rb.erb', "#{opts.project}.rb"
+      
+      make.magic!
+    end
+
+Lets start off with the first line:
+
+    Pixii.called(:tyrone) do |make, opts|
+
+This conjures the Pixii potion. By default the name of a new project is taken form `ARGV.first` but you can change this by passing in an options hash.
+
+    Pixii.called(:tyrone, :project => 'my_project_name', :foo => 'bar') do |make, opts|
+
+To access `:foo` in the potion you can just call `opts.foo`.
+
+Next up are the three basic spells, `dir`, `clone` and `template`. `dir` just makes the directories in the project. `clone` copies a file from one place to another. You can specify any type of path, including ones on the internet.
+
+Lastly `template` processes a template. By default it looks for templates in `../templates` but you can change this in the options:
+
+    Pixii.called(:tyrone, :templates => '../my_other_template_place') do |make, opts|
+
+Pixii only supports ERB processing. In your template you have access to all same variables in `opts`, plus any more you pass in. For example:
+
+    make.template 'sinatra.rb.erb', "#{opts.project}.rb", :foo => 'bar'
+
+and in `sinatra.rb.erb`:
+
+    #!/usr/bin/env ruby
+    
+    # <%= project.upcase %>
+    puts 'Lets get a drink at the <%= foo %>'
+
+The last line, `make.magic!` just carries out the incantation that we've defined above.
+
+
+## Custom Spells
+
+I understand that three spells may not be enough for the more advanced wizards out there so lets run through making our own Pixii spell. How about a spell which clones a Git repository?
+
+    class Pixii
+      def git_clone(repo, dest)
+        step "Cloning #{repo}..." do
+          `git clone #{repo} #{dest}`
+        end
+      end
+    end
+
+Just place that at the top of your script. Pretty simple! The only new thing that you have to get is the `step` method. That basically just defines a step to run. The `"Cloning ..."` passed in at the start is just a string describing what you are doing. You don't have to pass anything there and `step do` is perfectly acceptable.
+
+You can now use this in your potion:
+
+    make.git_clone 'git://github.com/chrislloyd/gravtastic.git', 'vendor/gems/gravtastic'
+
+
+## Contributing
+
+Fork the project, submit a pull request and I'll get to it straight away. Or you can just checkout the source by running:
+
+    git clone git://github.com/chrislloyd/pixii.git
+
+## License
+
+Copyright (c) 2009 Chris Lloyd.
+
+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/Rakefile

@@ -0,0 +1,9 @@
+require 'mg'
+require 'spec/rake/spectask'
+
+MG.new('pixii.gemspec')
+
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_opts = ['--color']
+  t.spec_files = FileList['spec/**/*.rb']
+end

data/deps.rip

@@ -0,0 +1 @@
+git://github.com/mbleigh/mash.git bb4ed9b62df3a0130e5417a50e545d8c1e0e0014

data/lib/pixii.rb

@@ -0,0 +1,91 @@
+require 'open-uri'
+require 'fileutils'
+require 'erb'
+require 'uri'
+require 'rubygems'
+
+gem 'mash', '>= 0.0.3'
+require 'mash'
+
+class Mash
+  public :binding
+end
+
+class Pixii
+
+  attr_reader :opts
+  attr_accessor :name, :steps
+
+  def self.called(name, options={:project => ARGV.first, :templates => '../templates'})
+    g = new(name, options)
+    g.normalize_opts!
+    yield g, g.opts
+  end
+
+  def initialize(name, options)
+    self.name, self.opts, self.steps = name, options, []
+  end
+
+  def opts=(options)
+    @opts = Mash.new(options)
+  end
+
+  def normalize_opts!
+    # TODO: fix caller[1] hack
+    opts.src_dir = File.expand_path(File.dirname(caller[1].split(':').first))
+    opts.template_dir = File.join(opts.src_dir, opts.templates)
+    opts.dest_dir = File.expand_path(File.join(Dir.pwd, opts.project))
+  end
+
+  def step(msg=nil, &blk)
+    steps << [msg, blk]
+  end
+
+  def dir(*dirs)
+    dirs.each do |d|
+      step do
+        FileUtils.mkdir_p(d)
+      end
+    end
+  end
+
+  def clone(src, dest)
+    step do
+      src = File.join(opts.src_dir, src) if URI::parse(src).scheme.nil?
+      open(src) do |sf|
+        File.open(dest,'wb') do |f|
+          f.write(sf.read)
+        end
+      end
+    end
+  end
+
+  def template(src_tmpl, dest, env={})
+    step do
+      src_tmpl = File.join(opts.template_dir, src_tmpl)
+      tmpl = File.open(src_tmpl){|f| f.read }
+
+      env = env.merge!(opts).to_mash
+      File.open(dest,'w') do |f|
+        f.write(ERB.new(tmpl).result(env.binding))
+      end
+    end
+  end
+
+  def magic!
+    make_and_change_to_dest! do
+      steps.each do |step|
+        puts step.first unless step.first.nil?
+        step.last.call
+      end
+    end
+  end
+
+  # private
+
+  def make_and_change_to_dest!(&blk)
+    FileUtils.mkdir_p opts.dest_dir
+    Dir.chdir(opts.dest_dir, &blk)
+  end
+
+end

data/spec/pixii_spec.rb

@@ -0,0 +1,31 @@
+require File.join(File.dirname(__FILE__),'spec_helper')
+
+describe Pixii do
+
+  def in_neverland(opts={}, &blk)
+    Pixii.called(:hook, {:project => 'pan'}.merge(opts), &blk)
+  end
+
+
+  it 'takes options' do
+    in_neverland(:foo => 'bar') do |m, o|
+      o.foo.should == 'bar'
+    end
+  end
+
+  it 'creates directories' do
+    dirs = %w(foo bar)
+
+    in_neverland do |m,o|
+      m.dir *dirs
+      m.magic!
+    end
+
+    dirs.each{|dir| File.directory?("/pan/#{dir}").should be_true}
+  end
+
+  after(:all) do
+    FakeFS::FileSystem.clear
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+require 'pixii'
+require 'fakefs'

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: pixii
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Chris Lloyd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-02 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mash
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.3
+    version: 
+description: 
+email: christopher.lloyd@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- deps.rip
+- Rakefile
+- README.md
+- lib/pixii.rb
+- spec/pixii_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/chrislloyd/pixii
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: pixii
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: I believe in you, Peter Pan.
+test_files: []
+