gasciiart 0.0.1

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Drew Blas
+
+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,52 @@
+# Gasciiart
+
+Gasciiart creates an animated git repository.  Each frame of ASCII animation is a separate commit.
+
+Using the run.sh script, the repository will "play" itself by checking out each commit in turn and displaying it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gasciiart'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gasciiart
+
+## Usage
+
+You should have an input directory where each frame to be animated is a separate file.  e.g.:
+
+    - input/
+      - 00001.txt
+      - 00002.txt
+      - 00003.txt
+      - 00004.txt
+
+(The filenames are sorted by Ruby, so use any naming scheme as long as the sort results in the order you want)
+
+Run the command:
+
+    gasciiart --source input/ --target output/
+
+(The output directory must **not** exist beforehand)
+
+The output directory will have the run.sh script to start the animation.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+Copyright (c) 2012 Drew Blas. See LICENSE.txt for further details.
+

data/bin/gasciiart

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'rubygems'
+require 'gasciiart'
+
+options = {}
+source = './'
+target = "output"
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: gasciiart [options]"
+
+  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+    options[:verbose] = v
+  end
+
+  opts.on("-t", "--target DIRECTORY", "Targets an EMPTY directory as the output for the resulting repo.  Defaults to 'output'") do |file|
+    target = file
+  end
+
+  opts.on("-s", "--source DIRECTORY", "Source directory of inputs") do |file|
+    source = file
+  end
+
+  opts.on('-h', '--help', 'Dispaly this screen') do
+    puts opts
+    exit
+  end
+end.parse!
+
+b = Gasciiart::Builder.new(source, target, options)
+b.build!
+

data/lib/gasciiart.rb

@@ -0,0 +1,20 @@
+require 'gasciiart/version'
+require 'gasciiart/builder'
+
+module Gasciiart
+  RUNNER = <<-EOF
+#!/bin/bash
+
+echo "\033[0;40m"
+
+for ref in `git rev-list HEAD --reverse`
+do
+  git checkout $ref > /dev/null 2> /dev/null
+  clear
+  cat animation.txt
+  sleep 0.05
+done
+
+git checkout HEAD
+  EOF
+end

data/lib/gasciiart/builder.rb

@@ -0,0 +1,104 @@
+require 'fileutils'
+
+class Gasciiart::Builder
+  attr_reader :source, :target, :options
+
+  def initialize(source, target, options = {})
+    @source, @target, @options = source, target, options
+    @source = "#{@source}/" unless @source[-1..-1] == '/'
+    @target = "#{@target}/" unless @target[-1..-1] == '/'
+    @verbose = options[:verbose]
+
+    @starting_dir = Dir.pwd
+    @target_animation = "#{@target}animation.txt"
+  end
+
+  # Where all the magic happens
+  # Setups up the output and loops through each file from the source (in `ls` order)
+  # Creating a commit for each file
+  def build!
+    test_git!
+
+    file_list = Dir.glob("#{@source}*").sort # Pull the file list before creating the target directory
+
+    setup_target
+
+    add_runner
+
+    file_list.each do |infile_name|
+      rewrite_animation_frame infile_name
+      create_commit infile_name
+    end
+  end
+
+  # Creates and git inits the target directory
+  def setup_target
+    log "Setting up #{@target}"
+
+    if File.exists? @target
+      raise ArgumentError, %{Target directory "#{@target}" already exists}
+    end
+
+    FileUtils.mkdir @target
+
+    run "git init ."
+
+    # TODO: Create runner file
+  end
+
+  def rewrite_animation_frame(infile_name)
+    log "Writing #{infile_name}"
+    File.open(infile_name) do |infile|
+      File.open(@target_animation, 'w') do |outfile|
+        outfile.write infile.read  # This could be streamed, but a single animation frame is small enough.  Let's start simple
+      end
+    end
+  end
+
+  def create_commit(infile_name)
+    run %{git add animation.txt && git commit -m "#{infile_name}"}
+  end
+
+  def add_runner
+    filename = "#{@target}run.sh"
+    File.open(filename, 'w') do |f|
+      f.write Gasciiart::RUNNER
+    end
+
+    File.chmod 0755, filename
+
+    run %{git add run.sh && git commit -m "Added run.sh"}
+  end
+
+  protected
+
+  # Log the message if verbose is on
+  def log(msg)
+    puts msg if @verbose
+  end
+
+  # Ensures there is the git command available
+  # TODO: Test git version
+  def test_git!
+    result = `which git`
+    if $?.exitstatus != 0
+      raise IOError, "Can't find git"
+    end
+  end
+
+  # Runs the specified command
+  #
+  # All run commands happen in the target dir
+  # but all file paths are relative to the starting directory, so all the switching happens here
+  def run(cmd)
+    Dir.chdir @target
+
+    log "Running: #{cmd}"
+    `#{cmd}`
+    # if $?.exitstatus != 0
+    #   raise IOError, %{Error executing command: "#{cmd}"}
+    # end
+
+    Dir.chdir @starting_dir
+  end
+end

data/lib/gasciiart/version.rb

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

data/spec/builder_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Gasciiart::Builder do
+  let(:builder) { Gasciiart::Builder.new('./', 'output') }
+  subject { builder }
+
+  it 'should initialize' do
+    b = nil
+
+    # Not really necessary, since this exception isn't caught,
+    # but that's all this spec does, so let's be explicit
+    expect {
+      b = Gasciiart::Builder.new('./', 'output')
+    }.not_to raise_exception
+
+    b.source.should  == './'
+    b.target.should  == 'output/'
+    b.options.should == {}
+  end
+
+  context "setup_target" do
+    it "should create the directory" do
+      builder.setup_target
+      File.directory?("output/").should == true
+    end
+  end
+
+
+end

data/spec/gasciiart_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Gasciiart do
+  it 'should return the version' do
+    Gasciiart::VERSION.should be_a(String)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'rspec'
+# require 'fakefs'
+require 'fakefs/spec_helpers'
+require 'gasciiart'
+
+RSpec.configure do |config|
+  config.include FakeFS::SpecHelpers
+
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end
+
+# require 'rubygems'
+# require 'bundler'
+# begin
+#   Bundler.setup(:default, :development)
+# rescue Bundler::BundlerError => e
+#   $stderr.puts e.message
+#   $stderr.puts "Run `bundle install` to install missing gems"
+#   exit e.status_code
+# end
+# require 'test/unit'
+# require 'shoulda'
+
+# $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+# $LOAD_PATH.unshift(File.dirname(__FILE__))
+# require 'gasciiart'

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: gasciiart
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Drew Blas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-07 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 39
+        segments: 
+        - 2
+        - 10
+        - 0
+        version: 2.10.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :development
+  version_requirements: *id002
+description: Use this gem to create a git repo that can play it's file frames as a git animation
+email: 
+- drew.blas@gmail.com
+executables: 
+- gasciiart
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/gasciiart.rb
+- lib/gasciiart/builder.rb
+- lib/gasciiart/version.rb
+- bin/gasciiart
+- LICENSE.txt
+- README.md
+- spec/spec_helper.rb
+- spec/gasciiart_spec.rb
+- spec/builder_spec.rb
+homepage: http://github.com/drewblas/gasciiart
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: A generator for git-based asciiart animations
+test_files: 
+- spec/spec_helper.rb
+- spec/gasciiart_spec.rb
+- spec/builder_spec.rb