shift 0.1.0 → 0.4.0

data/lib/shift/cli.rb

@@ -0,0 +1,43 @@
+
+require 'shift'
+
+
+module Shift
+
+  # The `shifter` command line interface.
+  #
+  class CLI
+
+    USAGE = "Usage:   shifter <file> [action] [format]\n" +
+            "In pipe: shifter - format [action]\n\n" +
+            "Available formats and actions:\n\n" +
+            Shift.inspect_actions
+
+    def self.new
+      begin
+        super(*ARGV)
+      rescue ArgumentError
+        abort USAGE
+      end
+    end
+    
+    def initialize(path, a=nil, b=nil)
+      @path = path
+      @format, @action = stdin? ? [a,b] : [b,a]
+      @format ||= :echo
+      @action ||= :default
+    end
+
+    def stdin?
+      @path == '-'
+    end
+
+    def data
+      stdin? ? STDIN.read : File.read(@path)
+    end
+
+    def run!
+      puts Shift(data, @format).process(@action)
+    end
+  end
+end

data/lib/shift/errors.rb

@@ -12,9 +12,13 @@ module Shift
   #
   class DependencyError < Error; end
 
-  # Raised when you try to read a file for which there are
-  # no mappings without specifying its type.
+  class LookupError        < Error; end
+  class UnknownFormatError < LookupError; end
+  class UnknownActionError < LookupError; end
+
+  # Raised when encountering invalid mappings, like
+  # when there is a cycle in the map.
   #
-  class UnknownFormatError < Error; end
+  class MappingError < Error; end
 
 end

data/lib/shift/i/closure_compiler.rb

@@ -0,0 +1,23 @@
+
+
+module Shift
+  class ClosureCompiler < Interface
+
+    def self.gem_dependencies
+      %w{closure-compiler}
+    end
+
+    def self.engine_class
+      Closure::Compiler
+    end
+
+    def self.target_format
+      'min.js'
+    end
+
+    def process(str)
+      @engine.compile(str)
+    end
+
+  end
+end

data/lib/shift/{c → i}/coffee_script.rb

@@ -1,6 +1,6 @@
 
 module Shift
-  class CoffeeScript < Identity
+  class CoffeeScript < Interface
 
     def self.gem_dependencies
       %w{coffee-script}
@@ -10,12 +10,15 @@ module Shift
       %w{coffee-script}
     end
 
+    def self.target_format
+      'js'
+    end
+
     def initialize(opts={})
       @opts = opts
     end
     
-
-    def process_plain(str)
+    def process(str)
       ::CoffeeScript.compile(str, @opts)
     end
 

data/lib/shift/i/echo.rb

@@ -0,0 +1,9 @@
+module Shift
+  class Echo < Interface
+
+    def self.keep_extension?
+      true
+    end
+
+  end
+end

data/lib/shift/{c → i}/rdiscount.rb

@@ -1,16 +1,20 @@
 
 module Shift
-  class RDiscount < Identity
+  class RDiscount < Interface
 
     def self.gem_dependencies
       %w{rdiscount}
     end
 
+    def self.target_format
+      'html'
+    end
+
     def initialize(*switches)
       @switches = switches
     end
     
-    def process_plain(str)
+    def process(str)
       ::RDiscount.new(str, *@switches).to_html
     end
 

data/lib/shift/{c → i}/redcarpet.rb

@@ -1,15 +1,19 @@
 module Shift
-  class Redcarpet < Identity
+  class Redcarpet < Interface
 
     def self.gem_dependencies
       %w{redcarpet}
     end
 
+    def self.target_format
+      'html'
+    end
+
     def initialize(*switches)
       @switches = switches
     end
     
-    def process_plain(str)
+    def process(str)
       ::Redcarpet.new(str, *@switches).to_html
     end
 

data/lib/shift/{c → i}/sass.rb

@@ -1,15 +1,19 @@
 module Shift
-  class Sass < Identity
+  class Sass < Interface
 
     def self.gem_dependencies
       %w{sass}
     end
 
+    def self.target_format
+      'css'
+    end
+
     def initialize(opts={})
       @opts = opts
     end
     
-    def process_plain(str)
+    def process(str)
       ::Sass::Engine.new(str, @opts).render
     end
 

data/lib/shift/{c → i}/uglify_js.rb

@@ -1,17 +1,21 @@
 
 
 module Shift
-  class UglifyJS < Identity
+  class UglifyJS < Interface
 
     def self.gem_dependencies
       %w{uglifier}
     end
 
-    def self.compiler_class
+    def self.engine_class
       Uglifier
     end
 
-    def process_plain(str)
+    def self.target_format
+      'min.js'
+    end
+
+    def process(str)
       @engine.compile(str)
     end
 

data/lib/shift/{c → i}/yui_compressor.rb

@@ -1,6 +1,6 @@
 
 module Shift
-  class YUICompressor < Identity
+  class YUICompressor < Interface
 
     def self.gem_dependencies
       %w{yui-compressor}
@@ -10,11 +10,15 @@ module Shift
       %w{yui/compressor}
     end
 
-    def self.compiler_class
+    def self.engine_class
       YUI::JavaScriptCompressor
     end
 
-    def process_plain(str)
+    def self.target_format
+      'min.js'
+    end
+
+    def process(str)
       @engine.compress(str)
     end
 

data/lib/shift/i/zlib_reader.rb

@@ -0,0 +1,23 @@
+module Shift
+  class ZlibReader < Interface
+
+    def self.keep_extension?
+      false
+    end
+
+    def self.target_format
+      false
+    end
+
+    def initialize
+      require 'zlib'
+      require 'stringio'
+    end
+    
+    def process(data)
+      gz = Zlib::GzipReader.new(StringIO.new(data))
+      gz.read
+    end
+
+  end
+end

data/lib/shift/i/zlib_writer.rb

@@ -0,0 +1,27 @@
+module Shift
+  class ZlibWriter < Interface
+
+    def self.keep_extension?
+      true
+    end
+
+    def self.target_format
+      'gz'
+    end
+
+    def initialize
+      require 'zlib'
+      require 'stringio'
+    end
+    
+    def process(str)
+      StringIO.open('', 'w') do |io|
+        gz = Zlib::GzipWriter.new(io)
+        gz.write(str)
+        gz.close
+        io.string
+      end
+    end
+
+  end
+end

data/lib/shift/{c/identity.rb → interface.rb}

@@ -1,28 +1,13 @@
 
-
 module Shift
 
-  # Returns the input unaltered. The purpose is mainly to inherit
-  # from this when defining other, more useful compilers.
+  # The default Shift interface, from which other interfaces must
+  # inherit. Also works as an identity function or echo server, in
+  # that it echoes what it is given.
   #
-  class Identity
-
-    # Mixed into the resulting strings to make them easy to save.
-    #
-    module StringExtension
-
-      # Write the string to a sepcified path.
-      #
-      def write(path)
-        File.open(path, 'w') do |file|
-          file.write(self)
-        end
-        self
-      end
-    end
-
+  class Interface
 
-    # One-liner on what the user must have/do to make it available.
+    # One-liner on what the user can do to make it available.
     # Used in DependencyError.
     #
     def self.instructions
@@ -41,7 +26,7 @@ module Shift
       gem_dependencies.all? {|d| Gem.available?(d) }
     end
 
-    # A list of Rubygems needed for the component to work.
+    # A list of Rubygems needed for the interface to work.
     #
     def self.gem_dependencies
       []
@@ -53,10 +38,23 @@ module Shift
       gem_dependencies
     end
 
-    # The class of the wrapped compiler, or false if none
+    # The class of the wrapped generator, or false if none
     # is used.
     #
-    def self.compiler_class
+    def self.engine_class
+      false
+    end
+
+    # The format typically produced by the generator.
+    #
+    def self.target_format
+      false
+    end
+
+    # Whether to leave the old extension as is and append, like
+    # something.css => something.css.gzip
+    #
+    def self.keep_extension?
       false
     end
 
@@ -75,42 +73,41 @@ module Shift
       super
     end
 
-    # Create a new instance. Ignores the given options.
+    # Create a new instance with the given options.
     #
     def initialize(*prms)
-      if self.class.compiler_class
-        @engine = self.class.compiler_class.new(*prms)
+      if self.class.engine_class
+        @engine = self.class.engine_class.new(*prms)
       end
     end
 
-    # Process the supplied string, returning the resulting `String` (with a #write method attached to it).
+    # Process the supplied string, returning the resulting `String`.
     #
     def process(str)
-      process_plain(str).extend(StringExtension)
+      str.dup
     end
     alias :compress   :process
     alias :compile    :process
     alias :transform  :process
 
-    # Process the supplied string, returning the resulting `String`.
+    # Get the default filename of a transformed file.
+    # @param [String] file Path of the original file
+    # @return [String] default file name for the result.
     #
-    def process_plain(str)
-      str.dup
-    end
+    def rename(file)
+      return nil if file.nil?
 
-    # Read and process a file.
-    #
-    # @raise [DependencyError] when none of the mapped
-    #   implementations are available.
-    #
-    # @return [String] The processed `String`
-    #
-    def read(path)
-      process(File.read(path)).extend(StringExtension)
+      unless self.class.keep_extension?
+        file = file.is_a?(Symbol) ?
+          file.to_s : file.chomp(File.extname(file))
+      end
+      if self.class.target_format
+        file = file + '.' + self.class.target_format.to_s
+      end
+      file
     end
 
   end
-  Echo = Identity
 end
 
 

data/lib/shift/interface_list.rb

@@ -0,0 +1,67 @@
+module Shift
+  class InterfaceList
+
+    # Create a new InterfaceList, given an array of class names
+    # of shift interfaces. Immutable once created.
+    #
+    def initialize(ifaces)
+      @interfaces = ifaces
+    end
+
+    def to_hash
+      @interfaces.dup
+    end
+
+    def eql?(other)
+      @interfaces.eql? other.to_hash
+    end
+    alias :== :eql?
+
+    def hash
+      @interfaces.hash
+    end
+
+    def inspect
+      'InterfaceList' + @interfaces.inspect
+    end
+
+    # Pick the preferred available interface.
+    #
+    # @raise [DependencyError] when none of the interfaces
+    #   are available.
+    #
+    # @return [Class] The preferred available class
+    #
+    def pick
+      each_class {|kls| return kls if kls.available? }
+      raise DependencyError, "nothing available: " +
+        help_string
+    end
+
+  private
+
+    def help_string
+      if @interfaces.any?
+        @interfaces.inspect + " Possible solution: " +
+          first_class.instructions
+      else
+        'no interfaces mapped'
+      end
+    end
+
+    def each_class
+      @interfaces.each do |name|
+        yield get_iface(name)
+      end; nil
+    end
+
+    def first_class
+      get_iface(@interfaces.first)
+    end
+
+    def get_iface(name)
+      Shift.const_get(name)
+    end
+
+  end
+end