drcapulet-russell 0.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+== 0.0.1 / 08 March 2009
+
+* Setting up the entire thing

data/README.rdoc

@@ -0,0 +1,61 @@
+= Russell
+
+Ruby gem for setting up new web development projects
+
+It can read from user input or from a default config file
+
+== Install
+
+  sudo gem install drcapulet-russell
+
+== Usage
+
+To create a new project in the current directory, and be asked about every
+available framework
+
+  russell
+
+To create a project using a single framework, use
+
+  russell -f FRAMEWORK
+
+To use a config file, use
+
+  russell -c
+
+This command will automatically ask you to create a config file if it doesn't find one. Otherwise 
+it will automatically proceed through the install (in the current directory) without any prompts
+
+All of the options:
+
+  -c, --config                     Read the config file from the user's home directory
+  -f, --framework FRAMEWORK        Set up a new project using the specified framework.
+  -l, --list                       List all available frameworks
+  -n, --new                        Adds a new framework to the central system
+  -?, -h, --help                   Show this message
+  -v, --version                    Print version
+
+
+
+== License
+
+Copyright (c) 2008 Alex Coomans
+ 
+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/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:patch: 0
+:minor: 1

data/bin/russell

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# russell command line utility
+
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'russell'))
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'russell', 'exec'))
+
+command = Russell::Exec::Russell.new(ARGV)
+command.run!

data/lib/russell/commands/install_all.rb

@@ -0,0 +1,77 @@
+module Russell
+  module Commands
+    class InstallAll
+      attr_accessor :options
+      def initialize(working_path, options)
+        #self.options = options
+      end
+  
+      def perform
+        @currentdir = Dir.pwd # Setting the Current Driectory
+        # CSS Installer Framework Variables
+        @css = {}
+        @css["prefix"] = "Would you like to install the"
+        @css["response"] = "installing the"
+        
+        @cssframeworks = YAML::load(File.open("#{Russell.base_directory}/frameworks/manifest.yml"))
+        @cssframeworks.each do |framework|
+          
+          @config = YAML::load(File.open("#{Russell.base_directory}/frameworks/#{framework.chomp}.yml"))
+          @css['type'] = check_fw_type(@config)
+          q = ask(@css["prefix"], framework.capitalize.chomp, @css["type"], @css["response"])
+          if (q == 1)
+            @config['manifest'].each do |file|
+              puts "  [add] - #{file}"
+            end
+            show_src_code(@config)
+            if @config['inside']
+              cmd = `cp -R #{Russell.base_directory}/frameworks/#{framework.chomp} #{@currentdir}/#{framework}`  
+            else
+              cmd = `cp -R #{Russell.base_directory}/frameworks/#{framework.chomp}/* #{@currentdir}`
+            end
+          end
+        end
+      end
+      
+      protected
+      
+      def ask(prefix, question, endr, response)
+        print "#{prefix} #{question} #{endr}? [y/n] "
+        input = gets.chomp
+        if (input == "y")
+          puts "#{response.capitalize.to_s} #{question.to_s} #{endr}"
+          return 1
+        elsif (input == "n")
+          puts "Not #{response} #{question} #{endr}"
+          return 0
+        else
+          puts "Error!"
+          exit
+        end
+      end
+      
+      def show_src_code(config)
+        puts ""
+        puts "----------------------------"
+        puts "To include in your project, add the following to the head section of your file:"
+        puts ""
+        config['src'].each do |line|
+          puts "   #{line}"
+        end
+        puts ""
+      end
+      
+      def check_fw_type(config)
+        if (config['type'] == "CSS")
+          return "CSS Framework"
+        elsif (config['type'] == "JS")
+          return "Javascript Framework"
+        else
+          return ""
+        end
+      end
+      
+# End Class Declaration
+    end
+  end
+end

data/lib/russell/commands/install_config.rb

@@ -0,0 +1,87 @@
+require "yaml"
+
+module Russell
+  module Commands
+    class InstallConfig
+      attr_accessor :options
+      def initialize(working_path, options)
+        self.options = options
+      end
+  
+      def perform
+        begin
+          @config = YAML::load(File.open("#{Russell.base_directory}/russell.config"))
+          read_and_install_with_config(@config)
+        rescue
+          q = ask("No config file exists. Create one?", "Not creating one. Exiting")
+          if (q == 1)
+            create_config
+          end
+        end
+        
+      end
+      
+      protected 
+      
+      def ask(question, exit)
+        print "#{question} [y/n] "
+        input = gets.chomp
+        if (input == "y")
+          return 1
+        else
+          puts exit
+          exit
+        end
+      end
+      
+      def create_config
+        config = {}
+        @frameworks = YAML::load(File.open("#{Russell.base_directory}/frameworks/manifest.yml"))
+        @frameworks.each do |fwname|
+          q = ask("Do you want to automatically install the #{fwname.chomp.capitalize} framework using you config file?", "")
+          if (q == 1)
+            config["#{fwname}"] = true
+          else
+            config["#{fwname}"] = false
+          end
+        end
+        write_config(config)
+      end
+      
+      def write_config(config)
+        wconfig = ""
+        config.each do |key, value|
+          wconfig = wconfig + "#{key.chomp}: #{value}
+
+"
+        end
+        File.open( "#{Russell.base_directory}/russell.config", "w" ) do |file| 
+          file.puts "#{wconfig}"
+        end
+      end
+      
+      def read_and_install_with_config(config)
+        command = :install_one
+        config.each do |fw, value|
+          if value
+            self.options[:noask] = true
+            self.options[:framework] = fw
+            do_command(command, options)
+          end
+        end
+      end
+      
+      def do_command(command, options)
+        command_class_name = command.to_s.split(/_/).map{|p| p.capitalize}.join('')
+        command_class = eval("::Russell::Commands::#{command_class_name}")
+        command_class.new(Dir.getwd, options).perform
+      end
+      
+# End Class Declaration
+    end
+  end
+end
+
+Dir.glob(File.join(Russell.lib_directory, 'russell', 'commands', "*.rb")).each do |file|
+  require file
+end

data/lib/russell/commands/install_one.rb

@@ -0,0 +1,90 @@
+require "yaml"
+
+module Russell
+  module Commands
+    class InstallOne
+      attr_accessor :options
+      def initialize(working_path, options)
+        self.options = options
+      end
+  
+      def perform
+        framework = self.options[:framework]
+        @currentdir = Dir.pwd # Setting the Current Driectory
+        # CSS Installer Framework Variables
+        @css = {}
+        @css["prefix"] = "You are going to install the"
+        @css["response"] = "installing the"
+        
+        begin
+          @config = YAML::load(File.open("#{Russell.base_directory}/frameworks/#{framework.chomp}.yml"))
+        rescue
+          puts "The specifiec framework is not available! Exiting!"
+          exit
+        end
+        
+        @css["type"] = check_fw_type(@config)
+        
+        if (self.options[:noask] == false)
+          q = ask(@css["prefix"], framework.capitalize.chomp, @css["type"], @css["response"])
+        else
+          q = 1
+        end
+        
+        if (q == 1)
+          @config['manifest'].each do |file|
+            puts "  [add] - #{file}"
+          end
+          show_src_code(@config)
+          if @config['inside']
+            cmd = `cp -R #{Russell.base_directory}/frameworks/#{framework.chomp} #{@currentdir}/#{framework}`  
+          else
+            cmd = `cp -R #{Russell.base_directory}/frameworks/#{framework.chomp}/* #{@currentdir}`
+          end
+        end
+      end
+      
+      protected
+      
+      def ask(prefix, question, endr, response)
+        print "#{prefix} #{question} #{endr}. Continue? [y/n] "
+        input = gets.chomp
+        if (input == "y")
+          puts "#{response.capitalize.to_s} #{question.to_s} #{endr}"
+          return 1
+        elsif (input == "n")
+          puts "Not #{response} #{question} #{endr}"
+          return 0
+        else
+          puts "Error!"
+          exit
+        end
+      end
+      
+      def show_src_code(config)
+        if config['src']
+          puts ""
+          puts "----------------------------"
+          puts "To include in your project, add the following to the head section of your file:"
+          puts ""
+          config['src'].each do |line|
+            puts "   #{line}"
+          end
+          puts ""
+        end
+      end
+      
+      def check_fw_type(config)
+        if (config['type'] == "CSS")
+          return "CSS Framework"
+        elsif (config['type'] == "JS")
+          return "Javascript Framework"
+        else
+          return ""
+        end
+      end
+
+# End Class Declaration      
+    end
+  end
+end

data/lib/russell/commands/list_fw.rb

@@ -0,0 +1,34 @@
+require "yaml"
+
+module Russell
+  module Commands
+    class ListFw
+      attr_accessor :options
+      def initialize(working_path, options)
+        #self.options = options
+      end
+  
+      def perform
+        @frameworks = YAML::load(File.open("#{Russell.base_directory}/frameworks/manifest.yml"))
+        puts ""
+        @frameworks.each do |framework|
+
+          @config = YAML::load(File.open("#{Russell.base_directory}/frameworks/#{framework.chomp}.yml"))
+          putup = <<END
+#{@config['name']}
+===================
+
+#{@config['description']}
+
+---------------------------------------------------------------------
+
+END
+          puts putup
+        end
+        
+      end
+  
+# End Class Declaration
+    end
+  end
+end

data/lib/russell/commands/new_fw.rb

@@ -0,0 +1,103 @@
+require "yaml"
+
+module Russell
+  module Commands
+    class NewFw
+      attr_accessor :options
+      def initialize(working_path, options)
+        self.options = options
+      end
+  
+      def perform
+        @currentdir = Dir.pwd # Setting the Current Driectory
+        # CSS Installer Framework Variables
+        fw = {}
+        
+        question = "You are going to install a new framework to russell"
+        #q = ask(question)
+        
+        print "What would you like this framework to be named? "
+        fw['name'] = gets.chomp
+        
+        print "Where is the base folder located? "
+        fw['dir'] = gets.chomp
+        
+        print "What would you like the description for the project to be? "
+        fw['description'] = gets.chomp
+        
+        print "Do you want the files to be placed in their own directory? [y/n] "
+        input = gets.chomp
+        if (input == "y")
+          fw['inside'] = true
+        else
+          fw['inside'] = false
+        end
+        
+        puts "Generating Manifest"
+        fwdir = fw['dir']
+        files = []
+        
+
+  
+        Dir.chdir(fwdir)
+        Dir["**/**"].each do |file|
+          next if File.directory?(file)
+          #puts " #{file}"
+          files << file
+        end
+
+        manifest = ""
+        files.each do |file|
+          manifest = manifest + "
+    #{file}
+"
+        end
+        
+        mancontent = "
+name:
+  #{fw['name']}
+
+description:
+  #{fw['description']}
+  
+inside: #{fw['inside']}
+
+manifest: 
+#{manifest}
+
+"
+        
+        File.open("#{Russell.base_directory}/frameworks/#{fw['name']}.yml", "w") { |f| f.write(mancontent) }
+        
+        fwmanifest = YAML::load(File.open("#{Russell.base_directory}/frameworks/manifest.yml"))
+        fwmani = ""
+        fwmanifest.each do |fwn|
+          fwmani = fwmani + "  
+#{fwn}"
+        end
+        fwmani = fwmani + "    
+   
+#{fw['name']}"
+        File.open("#{Russell.base_directory}/frameworks/manifest.yml", "w") { |f| f.write(fwmani) }
+
+      end
+      
+      protected
+      
+      def ask(question)
+        print "#{question}. Continue? [y/n] "
+        input = gets.chomp
+        if (input == "y")
+          return 1
+        elsif (input == "n")
+          puts "Qutting"
+          exit
+        else
+          puts "Error!"
+          exit
+        end
+      end
+# End Class Declaration
+    end
+  end
+end

data/lib/russell/commands/print_version.rb

@@ -0,0 +1,23 @@
+module Russell
+  module Commands
+    class PrintVersion
+      attr_accessor :options
+      def initialize(working_path, options)
+        #self.options = options
+      end
+  
+      def perform
+        # if options[:quiet]
+          # The quiet option may make scripting easier
+        #  puts ::Russell.version[:string]
+        # else
+          lines = []
+          lines << "Russell #{::Russell.version[:string]}"
+          lines << "Copyright (c) 2009 Alex Coomans"
+          lines << "Released under the MIT License."
+          puts lines.join("\n")
+        # end
+      end
+    end
+  end
+end

data/lib/russell/exec.rb

@@ -0,0 +1,98 @@
+# Handles the brunt work, not not the commands.
+# Sets up the option parsing and actions when
+# a flag is triggered
+
+require 'optparse' 
+require 'rdoc/usage'
+require 'ostruct'
+
+module Russell
+  module Exec
+    class Russell
+      
+      attr_accessor :args, :options, :opts
+      
+      # Takes the arugments from the command-line and sets up an empty hash. Then it continues on to parse!
+      def initialize(args)
+        self.args = args
+        self.options = {}
+        parse!
+      end
+      
+      # Runs the entire program. Run after parse! has completed
+      def run!
+        perform!
+      end
+      
+      protected
+      
+      def perform!
+        if options[:command]
+          do_command(options[:command])
+        else
+          puts self.opts
+        end
+      end
+      
+      def parse!
+        self.opts = OptionParser.new(&method(:set_opts))
+        self.opts.parse!(self.args)    
+        # if self.args.size > 0
+        #   self.options[:project_name] = trim_trailing_separator(self.args.shift)
+        # end
+        if self.args.size == 0
+        end
+        self.options[:command] ||= :install_all
+        self.options[:environment] ||= :production
+        self.options[:framework] ||= :f960
+        self.options[:project_type] ||= :stand_alone
+      end
+      
+      # Sets up all of the options
+      def set_opts(opts)
+        opts.banner = <<END
+Usage: russell [options] [project]
+
+Options:
+END
+        opts.on('-c', '--config', 'Read the config file from the user\'s home directory') do
+          self.options[:config] = true
+          self.options[:command] = :install_config
+        end
+
+        opts.on('-f FRAMEWORK', '--framework FRAMEWORK', 'Set up a new project using the specified framework.') do |framework|
+          self.options[:command] = :install_one
+          self.options[:framework] = framework
+        end
+        
+        opts.on('-l', '--list', 'List all available frameworks') do
+          self.options[:command] = :list_fw
+        end
+        
+        opts.on('-n', '--new', 'Adds a new framework to the central system') do
+          self.options[:command] = :new_fw
+        end
+        
+        opts.on_tail("-?", "-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+        
+        opts.on_tail("-v", "--version", "Print version") do
+          self.options[:command] = :print_version
+        end
+      end
+      
+      def do_command(command)
+        command_class_name = command.to_s.split(/_/).map{|p| p.capitalize}.join('')
+        command_class = eval("::Russell::Commands::#{command_class_name}")
+        command_class.new(Dir.getwd, options).perform
+      end
+      
+    end
+  end
+end
+
+Dir.glob(File.join(File.dirname(__FILE__), 'commands', "*.rb")).each do |file|
+  require file
+end

data/lib/russell/version.rb

@@ -0,0 +1,68 @@
+
+module Russell
+  module Version
+    # Returns a hash representing the version.
+    # The :major, :minor, and :teeny keys have their respective numbers.
+    # The :string key contains a human-readable string representation of the version.
+    # If checked out from Git,
+    # the :rev key will have the revision hash.
+    #
+    # This method swiped from Haml and then modified, some credit goes to Nathan Weizenbaum
+    # I (alex) then swiped it from Compass - so thanks there!
+    attr_writer :version
+    def version
+      return @version if defined?(@version)
+
+      read_version_file
+      parse_version
+
+      if r = revision
+        @version[:rev] = r
+        @version[:string] << " [#{r[0...7]}]"
+      end
+
+      @version
+    end
+
+    protected
+
+    def scope(file) # :nodoc:
+      File.join(File.dirname(__FILE__), '..', '..', file)
+    end
+
+    def read_version_file
+      @version = {
+        :string => File.read(scope('VERSION')).strip
+      }
+    end
+
+    def parse_version
+      dotted_string, @version[:label] = @version[:string].split(/-/, 2)
+      numbers = dotted_string.split('.').map { |n| n.to_i }
+      [:major, :minor, :teeny].zip(numbers).each do |attr, value|
+        @version[attr] = value
+      end
+    end
+
+    def revision
+      revision_from_git || revision_from_file
+    end
+
+    def revision_from_file
+      if File.exists?(scope('REVISION'))
+        rev = File.read(scope('REVISION')).strip
+        rev = nil if rev !~ /[a-f0-9]+/
+      end
+    end
+
+    def revision_from_git
+      if File.exists?(scope('.git/HEAD'))
+        rev = File.read(scope('.git/HEAD')).strip
+        if rev =~ /^ref: (.*)$/
+          rev = File.read(scope(".git/#{$1}")).strip
+        end
+      end
+    end
+
+  end
+end

data/lib/russell.rb

@@ -0,0 +1,19 @@
+# Sets up the basic global stuff and loads in the version.rb file
+
+# Load the Version Module Lib file so that the arugment -v works easier
+require File.expand_path(File.join(File.dirname(__FILE__), 'russell', 'version'))
+
+module Russell
+  extend Russell::Version
+  # Defines the base russel directory. Refers to the russell
+  # directory above the bin and lib directories
+  # 
+  def base_directory
+    File.expand_path(File.join(File.dirname(__FILE__), '..'))
+  end
+  def lib_directory
+    File.expand_path(File.join(File.dirname(__FILE__)))
+  end
+  module_function :base_directory, :lib_directory
+end
+

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: drcapulet-russell
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alex Coomans
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-08 00:00:00 -08:00
+default_executable: russell
+dependencies: []
+
+description: russell is a command line utility for setting up new web projects with ease
+email: alex@alexcoomans.com
+executables: 
+- russell
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- CHANGELOG.rdoc
+- README.rdoc
+- VERSION.yml
+- bin/russell
+- lib/russell
+- lib/russell/commands
+- lib/russell/commands/install_all.rb
+- lib/russell/commands/install_config.rb
+- lib/russell/commands/install_one.rb
+- lib/russell/commands/list_fw.rb
+- lib/russell/commands/new_fw.rb
+- lib/russell/commands/print_version.rb
+- lib/russell/exec.rb
+- lib/russell/version.rb
+- lib/russell.rb
+has_rdoc: true
+homepage: http://github.com/drcapulet/russell
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: russell is a command line utility for setting up new web projects with ease
+test_files: []
+