RubyGems - hawknee - Versions diffs - 0.2.0 → 0.2.1 - Mend

hawknee 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (22) hide show

data/CHANGELOG.rdoc +6 -0
data/README.rdoc +5 -1
data/app/controllers/hawknee/application_controller.rb +5 -0
data/app/controllers/hawknee/main_controller.rb +11 -0
data/app/views/hawknee/main/index.html.erb +2 -0
data/app/views/layouts/hawknee/application.html.erb +9 -0
data/bin/hawknee +15 -0
data/config/routes.rb +7 -0
data/init.rb +1 -0
data/lib/generators/hawknee/install/install_generator.rb +10 -0
data/lib/hawknee.rb +3 -0
data/lib/hawknee/cli.rb +106 -0
data/lib/hawknee/colors.rb +75 -0
data/lib/hawknee/commands/new.rb +15 -0
data/lib/hawknee/engine.rb +8 -0
data/lib/hawknee/helpers.rb +52 -0
metadata +19 -11
data/.document +0 -5
data/Gemfile +0 -13
data/Gemfile.lock +0 -20
data/Rakefile +0 -57
data/hawknee.gemspec +0 -64

data/CHANGELOG.rdoc CHANGED

@@ -1,3 +1,9 @@
+= hawknee 0.2.1 (07-03-2011)
+- Routes are now working! (I mean, this '/forum' scope works!)
+- Yay! ARGV.first now working as a command!
+- Added the hawknee:install generator. Now it's not working, but it will be in next versions.
 = hawknee 0.2.0 (06-03-2011)
 - Birthday!

data/README.rdoc CHANGED

@@ -8,6 +8,11 @@ Hawknee is a gem that implements a forum, to your Rails 3.0 app.
 	gem install hawknee
+or get the .gem package from {here}[https://rubygems.org/gems/hawknee] and type
+	cd /directory/where/the/.gem/file/is
+	gem install hawknee-x.y.z.gem
 2. Then, to install the forum:
 	cd /path/to/your/rails/app/path  # Go to your Rails app
@@ -21,7 +26,6 @@ Hawknee is a gem that implements a forum, to your Rails 3.0 app.
 Hawknee uses:
 - rails >= 3.0.0
-- haml >= 3.0.25
 == Contributing to Hawknee

data/app/controllers/hawknee/application_controller.rb ADDED

@@ -0,0 +1,5 @@
+module Hawknee
+	class ApplicationController < ::ApplicationController
+	end
+end

data/app/controllers/hawknee/main_controller.rb ADDED

@@ -0,0 +1,11 @@
+module Hawknee
+	class MainController < Hawknee::ApplicationController
+		# GET /forum
+		def index
+			respond_to do |format|
+				format.html { render :layout => 'hawknee/application' }
+			end
+		end
+	end
+end

data/app/views/hawknee/main/index.html.erb ADDED

	@@ -0,0 +1,2 @@
1	+ <h1>Aye!</h1>
2	+ <p>We're on a board, comrade!</p>

data/app/views/layouts/hawknee/application.html.erb ADDED

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<title>Hawknee</title>
+	</head>
+	<body>
+		<%= yield %>
+	</body>
+</html>

data/bin/hawknee ADDED

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# Add the lib directory to $LOAD_PATH
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+# Require needed files
+require 'hawknee'
+require 'hawknee/cli'
+# We make the --help option the default (if no command passed, show help)
+ARGV << '--help' if ARGV.empty? && $stdin.tty?
+# Run!
+Hawknee::Cli.new(ARGV)

data/config/routes.rb ADDED

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do
+	scope "forum", :module => :hawknee, :as => "hawknee" do
+		controller "main" do
+			match "/", :to => :index, :as => "portal"
+		end
+	end
+end

data/init.rb ADDED

	@@ -0,0 +1 @@
1	+ require 'hawknee'

data/lib/generators/hawknee/install/install_generator.rb ADDED

@@ -0,0 +1,10 @@
+module Hawknee
+	class InstallGenerator < Rails::Generators::Base
+		source_root File.expand_path('../templates', __FILE__)
+		class_option :path, :type => :string, :default => "#{Dir.pwd}", :desc => "Sepcifies the directory where the app, you want to install Hawknee in, lives."
+		def manifest
+			puts "Welllcome to Hawknee installation script, stranger!\n\nInstallation to #{options[:path]}"
+		end
+	end
+end

data/lib/hawknee.rb CHANGED

@@ -0,0 +1,3 @@
+require 'hawknee/engine' if defined? Rails && Rails::VERSION::MAJOR == 3
+module Hawknee; end

data/lib/hawknee/cli.rb ADDED

@@ -0,0 +1,106 @@
+# For nice --options parsing
+require 'optparse'
+# Require some needed files
+require 'hawknee/version'
+require 'hawknee/colors'
+require 'hawknee/helpers'
+# For nice 'n' clean code
+include Hawknee::Helpers
+module Hawknee
+	# You know.. Command Line Interface.. Got it? :)
+	class Cli
+		# Command classes inherit from this module, so we keep command class names separatly with classes somewhere in code.
+		# In other words.. Only class which inherits from Hawknee::Cli::Command can be a command.
+		module Command
+			Dir["#{File.dirname(__FILE__)}/commands/*.rb"].each { |f| require f }
+		end
+		# Initialize new Cli, and.. here we go!
+		#
+		#     some enlightening:
+		#
+		#     @command        - ARGV.first
+		#     @options        - simple opts handler
+		#
+		def initialize(*args)
+			# Handles options
+			@options = {}
+			# Set up the command and subcommand
+			@command, @subcommand = parse_command
+			begin
+				opts = OptionParser.new do |opts|
+					opts.banner = "Usage: hawknee COMMAND [OPTIONS]"
+					opts.separator " "
+					opts.separator "Installing Hawknee:"
+					opts.separator "    rails new app_name                 # Make new Rails application"
+					opts.separator "    cd app_name                        # Switch to the app's directory"
+					opts.separator "    gedit Gemfile                      # Add: gem 'hawknee', '#{Hawknee::Version::STRING}'"
+					opts.separator "    rails generate hawknee:install     # Copies needed files"
+					opts.separator "    rails server                       # Runs the server"
+					opts.separator "    go to http://localhost:3000/forum"
+					opts.separator " "
+					opts.separator "    Have fun!"
+					opts.separator " "
+					opts.separator "Common options:"
+					opts.on('-v', '--version', 'Show version') do
+						puts "Hawknee " + Hawknee::Version::STRING
+						exit
+					end
+					opts.on('-h', '--help', 'Display this message') do
+						puts opts
+						exit
+					end
+				end.parse!
+			rescue OptionParser::InvalidOption => e
+				raise BadOption
+			end
+			# Here, in Hawknee, commands are simply classes, (kept in files in 'commands' directory) that inherits from Hawknee::Cli::Command.
+			# To see it in action, dig a bit in lib/commands/new.rb file
+			#
+			begin
+				# We make sure the command (class) exists.
+				run if command_exists?
+			# When user typed some class (command) that doesn't exists.
+			rescue BadCommand => e
+				puts e.message
+			# When typed ^C
+			rescue Interrupt
+				puts "\n[" + "interrupted".bold.colorize(:red) + "]"
+			end
+		end # initialize
+		def run
+			begin
+				eval "Hawknee::Cli::Command::#{@command.capitalize}.new.#{@subcommand}"
+			rescue NameError, NoMethodError
+				raise BadCommand
+			end
+		end # run
+		def parse_command
+			case ARGV.length
+				when 1
+					return ARGV.first.to_s, 'init'
+				when 2
+					if ARGV[1] != nil
+						return ARGV.first.to_s, ARGV[1].to_s
+					end
+			end
+		end
+	end # Cli
+end # Hawknee

data/lib/hawknee/colors.rb ADDED

@@ -0,0 +1,75 @@
+module Hawknee
+	# Effects for lines in terminal
+	Effects = {
+		:clear => "\e[0m",
+		:bold => "\e[1m",
+		:underline => "\e[4m",
+		:blink => "\e[5m",
+		:reverse => "\e[7m",
+		:hide => "\e[8m",
+	}
+	# Colors for lines in terminal
+	Colors = {
+		:black => "\e[30m",
+		:red => "\e[31m",
+		:green => "\e[32m",
+		:yellow => "\e[33m",
+		:blue => "\e[34m",
+		:magenta => "\e[35m",
+		:cyan => "\e[36m",
+		:white => "\e[37m",
+		:default => "\e[39m",
+		:on_black => "\e[40m",
+		:on_red => "\e[41m",
+		:on_green => "\e[42m",
+		:on_yellow => "\e[43m",
+		:on_blue => "\e[44m",
+		:on_magenta => "\e[45m",
+		:on_cyan => "\e[46m",
+		:on_white => "\e[47m",
+		:on_default => "\e[49m",
+	}
+end
+class String
+	# Colorizes a string
+	def colorize(symbol)
+		string = self
+		"#{Hawknee::Colors[symbol.downcase.to_sym]}#{string}#{Hawknee::Effects[:clear]}"
+	end
+	# Makes a string bold
+	def bold
+		string = self
+		"#{Hawknee::Effects[:bold]}#{string}#{Hawknee::Effects[:clear]}"
+	end
+	# Hides a string
+	def hide
+		string = self
+		"#{Hawknee::Effects[:hide]}#{string}#{Hawknee::Effects[:clear]}"
+	end
+	# Underlines a string
+	def underline
+		string = self
+		"#{Hawknee::Effects[:underline]}#{string}#{Hawknee::Effects[:clear]}"
+	end
+	# Reverses foreground and background colors
+	def reverse
+		string = self
+		"#{Hawknee::Effects[:reverse]}#{string}#{Hawknee::Effects[:clear]}"
+	end
+	# To be honest.. Dunno what this does :D
+	def blink
+		string = self
+		"#{Hawknee::Effects[:blink]}#{string}#{Hawknee::Effects[:clear]}"
+	end
+end

data/lib/hawknee/commands/new.rb ADDED

@@ -0,0 +1,15 @@
+module Hawknee::Cli::Command
+	class New
+		def init
+			puts "New fired up!"
+		end
+		def topic
+			puts "New topic fired up!"
+		end
+		def forum
+			puts "New forum fired up!"
+		end
+	end
+end

data/lib/hawknee/engine.rb ADDED

@@ -0,0 +1,8 @@
+require 'rails'
+module Hawknee
+	class Engine < Rails::Engine
+		engine_name :hawknee
+		paths.config.routes = "config/routes.rb"
+	end
+end

data/lib/hawknee/helpers.rb ADDED

@@ -0,0 +1,52 @@
+module Hawknee::Helpers
+	extend self
+	def ask(what)
+		print what
+		$stdin.gets.chomp.strip
+	end
+	# Ask user if he wants to do something. If he passed 'n' it exits.
+	#
+	#     usage examples:
+	#
+	#     confirm?                         # Puts "Are you sure to continue? (y/n): ", and waits for input
+	#     confirm? "Delete?"               # Puts "Delete? (y/n): ", and waits for input
+	#     puts "Confirmed" if confirm?     # Puts "Confirmed" if user passed 'y'
+	#
+	def confirm?(what = "Are you sure to continue?")
+		print what + " (y/n): " # Hmmm... DRY? Yeah. DRY. We keep ourselves before writing (y/n): several times.
+		if $stdin.gets.chomp.strip =~ /y/i then true else exit end # Exit if input != y
+	end
+	# Used to check if command user passed exists. If not, raises BadCommand, and shows appropriate note.
+	#
+	#     usage examples:
+	#
+	#     puts "Good" if command_exists? 'initialize'
+	#
+	def command_exists?
+		begin
+			true if eval "Hawknee::Cli::Command::#{@command.capitalize}.new"
+		rescue NameError
+			raise BadCommand
+		end
+	end
+	### Exceptions/errors down here
+	class BadOption < RuntimeError
+		def initialize
+			puts "Ooops!".bold.colorize(:red) + " It seems, you passed invalid option"
+			puts "Run with " + "-h".bold.colorize(:blue) + " or " + "--help".bold.colorize(:blue) + " option, to get some help."
+			exit
+		end
+	end
+	class BadCommand < RuntimeError
+		def initialize
+			puts "Ooops!".bold.colorize(:red) + " It seems, you typed some invalid command"
+			puts "Run with " + "-h".bold.colorize(:blue) + " or " + "--help".bold.colorize(:blue) + " option, to get some help."
+			exit
+		end
+	end
+end

metadata CHANGED

@@ -2,7 +2,7 @@
 name: hawknee
 version: !ruby/object:Gem::Version
   prerelease:
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - "Szymon Urba\xC5\x9B"
@@ -10,8 +10,8 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-03-06 00:00:00 +01:00
-default_executable:
+date: 2011-03-20 00:00:00 +01:00
+default_executable: hawknee
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -59,23 +59,31 @@ dependencies:
   version_requirements: *id004
 description: Easily implement a forum to your Rails 3 application.
 email: szymon.urbas@yahoo.com
-executables: []
+executables:
+- hawknee
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
 files:
-- .document
 - CHANGELOG.rdoc
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.rdoc
-- Rakefile
-- hawknee.gemspec
+- app/controllers/hawknee/application_controller.rb
+- app/controllers/hawknee/main_controller.rb
+- app/views/hawknee/main/index.html.erb
+- app/views/layouts/hawknee/application.html.erb
+- bin/hawknee
+- config/routes.rb
+- init.rb
+- lib/generators/hawknee/install/install_generator.rb
 - lib/hawknee.rb
+- lib/hawknee/cli.rb
+- lib/hawknee/colors.rb
+- lib/hawknee/commands/new.rb
+- lib/hawknee/engine.rb
+- lib/hawknee/helpers.rb
 - lib/hawknee/version.rb
 - test/helper.rb
 - test/test_hawknee.rb
@@ -93,7 +101,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      hash: 281582899
+      hash: -718481523
       segments:
       - 0
       version: "0"

data/.document DELETED

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
--
-features/**/*.feature
-LICENSE.txt

data/Gemfile DELETED

@@ -1,13 +0,0 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
-  gem "rcov", ">= 0"
-end

data/Gemfile.lock DELETED

@@ -1,20 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    git (1.2.5)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    rake (0.8.7)
-    rcov (0.9.9)
-    shoulda (2.11.3)
-PLATFORMS
-  ruby
-DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.2)
-  rcov
-  shoulda

data/Rakefile DELETED

@@ -1,57 +0,0 @@
-# encoding: utf-8
-require './lib/hawknee/version'
-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 'rake'
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "hawknee"
-  gem.version = Hawknee::Version::STRING
-  gem.homepage = "http://github.com/semahawk/hawknee"
-  gem.license = "MIT"
-  gem.summary = %Q{Ruby on Rails 3 based forum.}
-  gem.description = %Q{Easily implement a forum to your Rails 3 application.}
-  gem.email = "szymon.urbas@yahoo.com"
-  gem.authors = ["Szymon Urbaś"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
-  #  gem.add_development_dependency 'rspec', '> 1.2.3'
-end
-Jeweler::RubygemsDotOrgTasks.new
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-task :default => :test
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = Hawknee::Version::STRING
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "Hawknee #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/hawknee.gemspec DELETED

@@ -1,64 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-Gem::Specification.new do |s|
-  s.name = %q{hawknee}
-  s.version = "0.2.0"
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Szymon Urbaś"]
-  s.date = %q{2011-03-06}
-  s.description = %q{Easily implement a forum to your Rails 3 application.}
-  s.email = %q{szymon.urbas@yahoo.com}
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    "CHANGELOG.rdoc",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.rdoc",
-    "Rakefile",
-    "hawknee.gemspec",
-    "lib/hawknee.rb",
-    "lib/hawknee/version.rb",
-    "test/helper.rb",
-    "test/test_hawknee.rb"
-  ]
-  s.homepage = %q{http://github.com/semahawk/hawknee}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.2}
-  s.summary = %q{Ruby on Rails 3 based forum.}
-  s.test_files = [
-    "test/helper.rb",
-    "test/test_hawknee.rb"
-  ]
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-    else
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-  end
-end