socks 0.1.9.beta → 0.1.10.beta

data/bin/socks

@@ -0,0 +1,230 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander/import'
+require 'socks'
+require 'fileutils'
+
+program :version, Socks::VERSION
+program :description, 'A Ruby-Rack-based microframework'
+
+default_command :about
+ 
+command :new do |c|
+  c.syntax = 'socks new [options]'
+  c.summary = 'Create a new Socks app'
+  c.description = 'Use Rack and other utilities to make a new Socks app from scratch'
+  c.action do |args, opt|
+
+    # Pull out the first arg in args[]
+    app = args[0]
+
+    # -------------------------------------------------------------------------
+    #                              File Contents                              |
+    # -------------------------------------------------------------------------
+    
+    config_ru = "# config.ru is used for running rack-based applications. Please do not edit this file without proper understanding of Rack
+# or some bad things may happen.
+
+
+# Bundler setup
+require \"bundler/setup\"
+Bundler.setup
+
+# http_router
+require File.expand_path(\"../config/router.rb\", __FILE__)
+
+# Controllers
+Dir[\"../app/controllers\" + \"*.rb\"].each do |file|
+  require file
+end
+
+# Used so Rack can automatically get updated to file contents without
+# a ten second cooldown
+use Rack::Reloader, 0
+
+# Used to run your router (app!)
+# Go to config/router.rb to declare routes
+run #{app.capitalize}::Router"
+
+    gemfile = "# List dependencies for your app in your Gemfile, then run the `bundle` command
+
+source \"http://rubygems.org\"
+
+# Socks itself!
+gem \"socks\", \"~> #{Socks::VERSION}\"
+
+# Rack HTTP
+gem \"rack\"
+
+# Startup your server with thin
+gem \"thin\"
+
+# Or use Foreman
+gem \"foreman\"
+
+# Use HttpRouter for routes (required)
+gem \"http_router\"
+
+# Mange todos, fixmes, etc. via tasks.rb with do_it
+gem \"do_it\"
+
+# Use Warden for authentication
+# gem \"warden\"
+
+group :development, :test do
+  # Use RSpec for tests
+  gem \"rspec\"
+
+  # Use Capybara to replicate the user
+  gem \"capybara\"
+end"
+
+    rakefile = "# Socks generates many helpful Rake tasks for you!
+require \"socks\"
+Socks::Tasks.install"
+
+    gitignore = ".DS_Store
+    Gemfile.lock"
+
+    procfile = "web: bundle exec rackup config.ru -p 4000"
+
+    app_template = "require \"socks\""
+
+    router_template = "# Declare the paths to your routes here.
+require \"http_router\"
+require \"socks\"
+
+module #{app.capitalize}
+    Router = HttpRouter.new do
+
+      # See what you can do at https://github.com/joshbuddy/http_router 
+
+    end
+end
+    "
+
+    config_template = "# Setup your main configuration here.
+
+Socks.configure do |config|
+end"
+
+    ########################
+    # Spec-helper template #
+    ########################
+    
+    spec_helper = "# Default helpers for your specs are added here
+require \"rspec\"
+require \"rspec-socks\"
+require \"rack\"
+"
+
+  dotrspec = "--color
+  --format documentation"
+
+  tasks = "# Put app TODOS, FIXMES, and/or NOTES in here.
+require \"do_it\"
+
+app = DoIt.new do
+  # See what you can do at https://github.com/Beakr/do_it
+end
+
+app.list # Format list"
+    
+
+    # -------------------------------------------------------------------------
+    #                                Creation                                 |
+    # ------------------------------------------------------------------------- 
+
+    FileUtils.mkdir app
+    FileUtils.cd app
+    FileUtils.mkdir %w( config spec )
+    FileUtils.touch %w( spec/spec_helper.rb .rspec ) # Spec file(s)
+    FileUtils.touch %w( Dofile ) # Todo manager
+    FileUtils.touch %w( config/app_config.rb )
+
+    # -------------------------------------------------------------------------
+    #                           File Initialization                           |
+    # -------------------------------------------------------------------------
+    
+
+    system("echo '#{config_ru}' >> config.ru")
+    system("echo '#{gemfile}' >> Gemfile")
+    system("echo '#{rakefile}' >> Rakefile")
+
+    system("echo '#{gitignore}' >> .gitignore")
+    system("echo '#{procfile}' >> Procfile")
+    system("echo '#{tasks}' >> Dofile")
+    
+    system("echo '#{router_template}' >> config/router.rb")
+    system("echo '#{config_template}' >> config/app_config.rb")
+
+    system("echo '#{spec_helper}' >> spec/spec_helper.rb")
+    system("echo '#{dotrspec}' >> .rspec")
+
+    system("bundle")
+
+  end
+end
+
+command :controller do |c|
+  c.syntax = 'socks controller [options]'
+  c.description = 'Create a template for something'
+  c.action do |args, options|
+    cont = args[0]
+
+    cont_template = "# Specify pages in the controller
+    
+# e.g.
+#
+# def index
+#   \"This is a socks app!\"
+# end
+#
+    
+class #{cont.capitalize}Controller < Socks::BaseController
+  # ...
+end
+    "
+
+    FileUtils.touch "app/controllers/#{cont}_controller.rb"
+    system("echo '#{cont_template}' >> app/controllers/#{cont}_controller.rb")
+
+  end
+end
+
+command :start do |c|
+  c.syntax = 'socks start [options]'
+  c.description = 'Startup a Rack server'
+  c.action do |args, options| 
+    system('foreman start') # Startup server including code in lib/ that runs on port 4000
+    notify "Socks server is up"
+  end
+end
+
+command :test do |c|
+  c.syntax = 'socks test [options]'
+  c.description = 'Run tests with RSpec'
+  c.action do |args, options|
+    system('rspec .')
+  end
+end
+
+command :version do |c|
+  c.syntax = 'socks version [options]'
+  c.description = 'Display the current version (altertative to --version)'
+  c.action do |args, options|
+    Socks::VERSION
+  end
+end
+
+command :about do |c|
+  c.syntax = 'socks about [options]'
+  c.action do |args, options|
+    system("echo \"\e[32m Usage: socks new APP_NAME\"")
+  end
+end
+
+# -------------------------------------------------------------------------
+#                                Helpers                                  |
+# -------------------------------------------------------------------------

data/lib/socks/router.rb

@@ -1,6 +1,9 @@
 require 'socks/router_helpers'
 
 module Socks
+
+    # This class is used as helpers, misc methods, etc. for the App:Router class
+    # generated in your app.
     class Router
       include Socks::RouterHelpers
     end

data/lib/socks/router_helpers.rb

@@ -1,9 +1,17 @@
 # General helpers for the Socks router
 
 module Socks
+
+  # This class is purely of helper methods for the Socks App::Router generated in
+  # router.rb of your Socks app.
   module RouterHelpers
+
+    # Takes the pain of filling in a text content-type for you
+    # @param [String] The string to display
+    # @return [text] The text rendered onto the screen
     def txt(str)
       return [200, {'Content-type' => 'text/plain'}, ["#{str}"]]
     end
+
   end
 end

data/lib/socks/version.rb

@@ -1,3 +1,6 @@
 module Socks
-  VERSION = "0.1.9.beta"
+
+  # The current version of Socks
+  VERSION = "0.1.10.beta"
+
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: socks
 version: !ruby/object:Gem::Version
-  version: 0.1.9.beta
-  prerelease: 6
+  version: 0.1.10.beta
+  prerelease: 7
 platform: ruby
 authors:
 - Chris Clarke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-03 00:00:00.000000000 Z
+date: 2012-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -139,13 +139,31 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: do_it
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: An in-development web framework using Rack.
 email:
 - beakr@ninjanizr.com
-executables: []
+executables:
+- socks
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/socks
 - lib/socks.rb
 - lib/socks/version.rb
 - lib/socks/config.rb