revans-gini 0.2.0

data/ChangeLog.rdoc

@@ -0,0 +1,16 @@
+
+Version 0.1.4
+	
+	* Added Mootools
+	* Added Prototype
+	* Added more documentation
+
+Version 0.1.2
+
+	* Fixed fetch bugs
+	* Changed some classnames so the read better
+
+Version 0.1.0
+
+	* Initial Creation
+	* jQuery is the only library currently supported

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2008 Code Wranglers, Inc. & Robert R Evans
+
+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.markdown

@@ -0,0 +1,49 @@
+# Gini
+
+Gini is a way to grab those files that you are tired of copying and pasting everytime, like the
+latest jQuery or Prototype. You tell gini what library you want, that is supported, and where you
+want it installed, unless you want it in the current directory and it will go get it for you.
+
+Additional options is downloading a compressed version, if it exists. 
+
+## Libraries Currently Supported
+
+* jQuery
+* Prototype
+* MooTools
+* 960 CSS Framework
+
+## Usage
+
+To choose the directory you want the library installed at (it will create any files that don't already exist)
+
+	gini --install jquery --path /Users/yourname/project/public/javascripts
+
+To install in your current directory:
+
+	gini --install prototype
+
+Ask for a compressed version of the library, if it exists
+
+	gini --install jquery -c
+
+Need some help?
+
+	gini -h
+
+That will show you all available options.
+
+## Install
+
+git clone git://github.com/revans/gini.git 
+cd gini
+gem build gini.gemspec
+sudo gem install gini-0.2.0.gem
+
+
+## Future Features
+
+* More Libraries
+* Hooks for using Github to grab libraries
+* Ability to download zip/tar files and unpack them
+* Possible support for your own libraries that live on your local machine in, say, a ~/.templates folder

data/bin/gini

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'gini'
+
+options = Gini::Options.parse(ARGV)
+Gini::Fetch.library(options)

data/lib/gini.rb

@@ -0,0 +1,20 @@
+module Gini
+  Version = "0.2.0"
+  
+  class LibraryNotSupported < StandardError; end
+  class LibraryNotSpecified < StandardError; end
+  
+  module Supported
+    Archives = %w[tar tar.gz tar.bz2 zip]
+  end
+end
+
+# Required Gems
+%w[fileutils optparse ostruct uri net/http pathname].each { |library| require library }
+
+# Gem specific Requires
+require File.dirname(__FILE__) + "/gini/extensions/string"
+require File.dirname(__FILE__) + "/gini/library"
+require File.dirname(__FILE__) + "/gini/parser"
+require File.dirname(__FILE__) + "/gini/extract"
+require File.dirname(__FILE__) + "/gini/fetch"

data/lib/gini/extensions/string.rb

@@ -0,0 +1,18 @@
+class String
+  
+  # change a pharse ('test it now') or ("test_it_now") to a classname ('TestItNow')
+  def classify
+    clean.split(' ').each { |word| word.capitalize! }.join('')
+  end
+  
+  # change a phrase ('testing now') to an instance variable name ('testing_now')
+  def instantify
+    clean.gsub(/\s+/, '_').downcase
+  end
+  
+  # clean a string of unwanted characters before we turn into a class or variable name
+  def clean
+    gsub(/[^\w\s\-\—]/,'').gsub(/[^\w]|[\_]/,' ').split.join(' ')  
+  end
+  
+end

data/lib/gini/extract.rb

@@ -0,0 +1,41 @@
+module Gini
+  class Extract
+    
+    def self.file(path, ext, library_name)
+      f = new
+      command       = f.uncompress_with(ext)
+      path_to_file  = f.search_for_file(path, library_name)
+
+      system("#{command} #{path_to_file}")
+    end
+    
+    
+    def uncompress_with(extension)
+      case extension
+      when "tar"        then "tar xvf"
+      when "tar.gz"     then "tar xzvf"
+      when "tar.bz2"    then "tar xvjf"
+      when "zip"        then "unzip"
+      else
+        raise Exception, "I don't know that extension" and exit(0)
+      end
+    end
+    
+    
+    def search_for_file(path, lib)
+      path = Pathname.new(path)
+      path.children.each do |p|
+        @archive_path = p.to_s if p.to_s =~ /#{lib}/
+      end
+      @archive_path
+    end
+    
+  end
+end
+
+# API
+# 
+# Takes the location of archived file and determines what type of un-archiving method should be used and does so.
+# That is all this class should do!
+#
+# Gini::Extract.file(archived_file)

data/lib/gini/fetch.rb

@@ -0,0 +1,208 @@
+module Gini
+  class Fetch
+    
+    attr_reader :options, :url
+    
+    
+    # Initialize
+    #
+    # ==== Description
+    #
+    # Checks to make sure a library is specified and we support it.
+    # Maps options and setups up the path, if it is not given.
+    #
+    def initialize(options)
+      raise LibraryNotSpecified, "You need to specify what Library you want to install" if options.library.nil?
+      raise LibraryNotSupported, "#{options.library} is not supported." unless Gini::Libraries.include?(options.library)
+      
+      @options                    = options
+      check_library_name
+      @options.path               = @options.path.nil? ? Dir.pwd : @options.path
+      @options.extension          = Gini::Library.const_get(@options.library.capitalize).const_get("Extension")
+      @options.installation_path  = File.join(@options.path, "#{@options.library.downcase}.#{@options.extension}")
+    end
+    
+    
+    # Gini::Fetch.library(options)
+    #
+    # ==== Description
+    #
+    # A Class method for installing a library
+    #
+    # ==== Returns
+    #
+    # Returns our exit message to let the user
+    # know what took place and where they can find the library
+    # on their system.
+    #
+    def self.library(options)
+      init = new(options)
+      init.install
+      # init.need_extraction
+      init.send_exit_message
+    end
+    
+    
+    # Install
+    #
+    # ==== Description
+    #
+    # Checks for a compressed version and if the user specified a compressed version
+    # Pulls the cooresponding Repo and downloads it and writes it to a file in the
+    # specified path, given by the user
+    #
+    def install
+      check_directory
+      check_compression
+      # archived? ? grab_archive : grab_single_file
+      grab_archive
+    end
+    
+    
+    # Grab a Single File
+    #
+    # ==== Description
+    #
+    # If it is a single, file, we'll use the traditional Ruby way
+    # of grabbing a file.
+    #
+    def grab_single_file
+      File.open(@options.installation_path, "w+") do |f|
+        f.write( Net::HTTP.get( URI.parse(@url) ) )
+      end
+    end
+    
+    
+    # Grab an Archived File
+    #
+    # ==== Description
+    #
+    # This uses a system call, curl, to grab an archive off of a server.
+    # It will then un-archive it (zip, tar, tar.gz, tar.bz2)
+    #
+    def grab_archive
+      FileUtils.cd @options.path
+      system("curl -L -O #{@url}")
+      extract_archive
+    end
+    
+    
+    # Check Directory
+    #
+    # ==== Description
+    #
+    # Check to see if a directory exists, if it does not
+    # then create it.
+    #
+    def check_directory
+      unless File.exists?(@options.path)
+        FileUtils.mkdir_p(@options.path)
+      end
+    end
+    
+    
+    # Check Compression
+    #
+    # ==== Description
+    #
+    # Checks to see if the user specified a compressed version and then sees if 
+    # a compressed version is available. The url instance variable is instanstiated
+    # accordingly.
+    #
+    # ==== Returns
+    #
+    # Returns the @url instance variable with the cooresponding url for the
+    # specified library repo.
+    #
+    def check_compression
+      if compression_is_used?
+        @url = Gini::Library.const_get(@options.library.capitalize).const_get("Compressed")
+      else
+        @url = Gini::Library.const_get(@options.library.capitalize).const_get("Repo")
+      end
+    end
+    
+    
+    # Extract the Archived File
+    #
+    # ==== Description
+    #
+    # Extracts the archived file into the current directory
+    # that it was downloaded into.
+    #
+    def extract_archive
+      name = Gini::Library.const_get(@options.library.capitalize).const_get("Name")
+      Gini::Extract.file(@options.path, @options.extension, name)
+    end
+    
+    
+    # Archived?
+    #
+    # ==== Description
+    #
+    # Is this an archived file?
+    #
+    # ==== Returns
+    #
+    # Returns a boolean value
+    #
+    def archived?
+      Gini::Supported::Archives.include?(@options.extension)
+    end
+    
+    
+    # Library Compression
+    #
+    # ==== Description
+    #
+    # Checks to see if we can offer a compressed version of the Library specified.
+    #
+    # ==== Returns
+    #
+    # A Boolean value
+    #
+    def library_compression?
+      !!Gini::Library.const_get(@options.library.capitalize).const_get("Compressed")
+    end
+    
+    
+    # Compression is Used?
+    #
+    # ==== Description
+    #
+    # Boolean method to check if the user has specified compression and the library
+    # has a compressed version of the library.
+    #
+    # ==== Return
+    #
+    # Returns a boolean response
+    #
+    def compression_is_used?
+      library_compression? && @options.compress
+    end
+    
+    
+    # Exit Message to let the User know what took place
+    #
+    def send_exit_message
+      puts "\n#{@options.library.capitalize} was installed at #{@options.installation_path} and compression was #{translate_to_words}.\n\n"
+    end
+    
+    
+    # Translate to Words
+    #
+    def translate_to_words
+      compression_is_used? ? "used" : "was not used"
+    end
+    
+    
+    def check_library_name
+      case @options.library
+      when "960"
+        @options.library = "grid960"
+      else
+      end
+    end
+    
+  end
+end

data/lib/gini/library.rb

@@ -0,0 +1,60 @@
+module Gini
+  
+  # Supported Libraries
+  Libraries = %w[jquery prototype mootools 960]
+  
+  module Library
+
+    # jQuery Repository Information
+    module Jquery
+      URL         = "http://jqueryjs.googlecode.com/files"
+      Version     = "1.2.6"
+      Repo        = "#{URL}/jquery-#{Version}.js"
+      Compressed  = "#{URL}/jquery-#{Version}.min.js"
+      Extension   = "js" # TODO: crappy hack
+    end
+    
+    
+    # Prototype Repository Information
+    module Prototype
+      URL         = "http://www.prototypejs.org/assets"
+      Version     = "1.6.0.3"
+      Repo        = "#{URL}/2008/9/29/prototype-#{Version}.js"
+      Compressed  = nil
+      Extension   = "js"
+    end
+    
+    
+    # MooTools Repository Information
+    module Mootools
+      URL         = "http://mootools.net/download/get"
+      Version     = "1.2.1"
+      Repo        = "#{URL}/mootools-#{Version}-core-nc.js"
+      Compressed  = "#{URL}/mootools-#{Version}-core-yc.js"
+      Extension   = "js"
+    end
+    
+    
+    # 960 Grid CSS Framework
+    module Grid960
+      URL         = "http://960.gs/files/960_download.zip"
+      Name        = "960"
+      Version     = nil
+      Repo        = "#{URL}"
+      Compressed  = nil
+      Extension   = "zip"
+    end
+    
+    
+    # Blueprint CSS Framework
+    # module Blueprint
+    #   URL         = "http://github.com/joshuaclayton/blueprint-css/tarball/master"
+    #   Name        = "blueprint"
+    #   Version     = "0.8"
+    #   Repo        = "#{URL}"
+    #   Compressed  = nil
+    #   Extension   = "tar.gz"
+    # end
+    
+  end
+end

data/lib/gini/parser.rb

@@ -0,0 +1,72 @@
+module Gini
+  class Options
+    
+    def self.parse(args)
+      options = OpenStruct.new
+      
+      # Parse Options
+      opts = OptionParser.new do |opts|
+        opts.banner = "\nGini Usage: gini --install jquery --path /Users/rrevans/Desktop -f"
+        opts.separator ""
+        opts.separator "Required Options"
+        
+        
+        # Install a specific library
+        opts.on("--install NAME", "Install a Library. Use gini -l to see available libraries.") do |ext|
+          raise Gini::LibraryNotSupported, "#{ext} is not a supported Library" and exit(0) unless Gini::Libraries.include?(ext)
+          options.library = ext
+        end
+        
+        
+        # Specify the location to install the library
+        opts.on("--path NAME", "Specify the path to install the library.") do |ext|
+          options.path = ext
+        end
+        
+        
+        # Show available libraries that Gini supports to install
+        opts.on("-l", "--libraries", "Show available libraries to install. Use the names listed as the name to be passed in to install.\n\t\t\t\t     e.g. gini --install 960") do |lib|
+          puts "\nAvailable Libraries:\n\n"
+          Gini::Libraries.each { |lib| puts "#{lib}\n" }
+          puts "\n"
+          exit(0)
+        end
+        
+        
+        # Boolean Switch to force overwrite
+        # opts.on("-f", "--force", "Force an Overwrite of a current file") do |ext|
+        #   options.force = ext
+        # end
+        
+        
+        # Boolean Switch to compression, if supported
+        opts.on("-c", "--compress", "Pull a compressed version, if available") do |ext|
+          options.compress = ext
+        end
+        
+        
+        # Simple Separator
+        opts.separator ""
+        opts.separator "Common Options"
+        
+        
+        # Help Screen
+        opts.on_tail("-h", "--help", "Show the help screen") do
+          puts opts
+          exit(0)
+        end
+        
+        
+        # Show Version
+        opts.on_tail("-v", "--version", "Show Gini's current version") do
+          puts "Gini is currently at Version #{Gini::Version}"
+          exit(0)
+        end
+      end
+      
+      opts.parse!(args)
+      options
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: revans-gini
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Robert R Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-18 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: A basic code generator for various existing libraries
+email: revans@robertrevans.com
+executables: 
+- gini
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+- ChangeLog.rdoc
+- LICENSE
+files: 
+- README.markdown
+- LICENSE
+- ChangeLog.rdoc
+- Rakefile
+- bin/gini
+- lib/gini.rb
+- lib/gini/extensions/string.rb
+- lib/gini/parser.rb
+- lib/gini/library.rb
+- lib/gini/fetch.rb
+- lib/gini/extract.rb
+has_rdoc: true
+homepage: http://www.robertrevans.com
+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: gini
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A basic code generator for various existing libraries
+test_files: []
+