monk 0.0.1 → 0.0.2

data/README.markdown

@@ -0,0 +1,70 @@
+Monk
+====
+
+The glue framework for web development.
+
+Description
+-----------
+
+Monk is a glue framework for web development. It means that instead of
+installing all the tools you need for your projects, you can rely on a
+git repository and a list of dependencies, and Monk will care of the
+rest. By default, it ships with a Sinatra application that includes
+Contest, Stories, Webrat, Ohm and some other niceties, along with a
+structure and helpful documentation to get your hands wet in no time.
+
+But Monk also respects your tastes, and you are invited to create your
+own versions of the skeleton app and your own list of dependencies. You
+can add many different templates (different git repositories) and Monk
+will help you manage them all.
+
+Usage
+-----
+
+Install the monk gem and create your project:
+
+    $ sudo gem install monk
+    $ monk init myapp
+    $ cd myapp
+    $ rake
+
+If the tests pass, it means that you can start hacking righ away. If
+they don't, just follow the instructions. As the default skeleton
+is very opinionated, you will probably need to install and run
+[Redis](http://code.google.com/p/redis/), a key-value database.
+
+Check the `dependencies` file in the root of your project to see what
+else is there. Monk works with git almost exclusively, but your project
+can also depend on gems. Check the dependencies file to see what options
+you have, and run the `dep` command line tool to verify it.
+
+Installation
+------------
+
+    $ sudo gem install monk
+
+License
+-------
+
+Copyright (c) 2009 Michel Martens and Damian Janowski
+
+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/Rakefile

@@ -0,0 +1,5 @@
+task :test do
+  system "cd test && ruby integration_test.rb"
+end
+
+task :default => :test

data/bin/monk

@@ -0,0 +1,51 @@
+#! /usr/bin/env ruby
+
+require "thor"
+
+class MonkTasks < Thor
+  namespace :monk
+
+  include Thor::Actions
+
+  desc "init", "Initialize a Monk application"
+  def init(target)
+    say_status :fetching, source
+    system "git clone -q --depth 1 #{source} #{target}"
+    inside(target) { remove_file ".git" }
+    say_status :create, target
+  end
+
+private
+
+  def source
+    monk_config["default"]
+  end
+
+  def monk_config_file
+    @monk_config_file ||= File.join(Thor::Util.user_home, ".monk")
+  end
+
+  def monk_config
+    @monk_config ||= begin
+      write_monk_config_file unless File.exists?(monk_config_file)
+      @monk_config = YAML.load_file(monk_config_file)
+    end
+  end
+
+  def write_monk_config_file
+    create_file monk_config_file do
+      config = { "default" => "git://github.com/monkrb/skeleton.git" }
+      config.to_yaml
+    end
+  end
+
+  def self.source_root
+    "."
+  end
+end
+
+if File.exists?("Thorfile")
+  load("Thorfile")
+end
+
+MonkTasks.start

data/lib/monk.rb

@@ -0,0 +1,56 @@
+# This file contains the bootstraping code for a Monk application.
+RACK_ENV = ENV["RACK_ENV"] ||= "development" unless defined? RACK_ENV
+
+# Helper method for file references.
+#
+# @param args [Array] Path components relative to ROOT_DIR.
+# @example Referencing a file in config called settings.yml:
+#   root_path("config", "settings.yml")
+def root_path(*args)
+  File.join(ROOT_DIR, *args)
+end
+
+require "sinatra/base"
+require "haml"
+require "sass"
+
+# TODO Add documentation.
+class Monk < Sinatra::Base
+  set :dump_errors, true
+  set :logging, true
+  set :methodoverride, true
+  set :raise_errors, Proc.new { test? }
+  set :root, root_path
+  set :run, Proc.new { $0 == app_file }
+  set :show_exceptions, Proc.new { development? }
+  set :static, true
+  set :views, root_path("app", "views")
+
+  use Rack::Session::Cookie
+
+  configure :development do
+    use Sinatra::Reloader
+  end
+
+  configure :development, :test do
+    require "ruby-debug" rescue LoadError
+  end
+
+  helpers do
+
+    # TODO Add documentation.
+    def haml(template, options = {}, locals = {})
+      options[:escape_html] = true unless options.include?(:escape_html)
+      super(template, options, locals)
+    end
+
+    # TODO Add documentation.
+    def partial(template, locals = {})
+      haml(template, {:layout => false}, locals)
+    end
+  end
+end
+
+require "monk/reloader"
+require "monk/logger"
+require "monk/settings"

data/lib/monk/logger.rb

@@ -0,0 +1,11 @@
+require 'logger'
+
+# TODO Add documentation.
+def logger
+  $logger ||= begin
+    $logger = ::Logger.new(root_path("log", "#{RACK_ENV}.log"))
+    $logger.level = ::Logger.const_get((settings(:log_level) || :warn).to_s.upcase)
+    $logger.datetime_format = "%Y-%m-%d %H:%M:%S"
+    $logger
+  end
+end

data/lib/monk/reloader.rb

@@ -0,0 +1,10 @@
+require "rack/reloader"
+
+# TODO Add documentation.
+class Monk::Reloader < Rack::Reloader
+  def safe_load(file, mtime, stderr = $stderr)
+    super
+    Monk.reset!
+    super(Monk.app_file, mtime, stderr)
+  end
+end

data/lib/monk/settings.rb

@@ -0,0 +1,14 @@
+require 'yaml'
+
+# TODO Add documentation.
+def settings(key)
+  $settings ||= YAML.load_file(root_path("config", "settings.yml"))[RACK_ENV.to_sym]
+
+  unless $settings.include?(key)
+    message = "No setting defined for #{key.inspect}."
+    defined?(logger) ? logger.warn(message) : $stderr.puts(message)
+  end
+
+  $settings[key]
+end
+

data/monk.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name              = "monk"
+  s.version           = "0.0.2"
+  s.summary           = "Monk, the glue framework"
+  s.description       = "Monk is a glue framework for web development. It means that instead of installing all the tools you need for your projects, you can rely on a git repository and a list of dependencies, and Monk will care of the rest. By default, it ships with a Sinatra application that includes Contest, Stories, Webrat, Ohm and some other niceties, along with a structure and helpful documentation to get your hands wet in no time."
+  s.authors           = ["Damian Janowski", "Michel Martens"]
+  s.email             = ["djanowski@dimaion.com", "michel@soveran.com"]
+  s.homepage          = "http://monkrb.com"
+
+  s.rubyforge_project = "monk"
+
+  s.executables << "monk"
+
+  s.add_dependency("wycats-thor", "~> 0.11")
+  s.add_dependency("dependencies", ">= 0.0.5")
+  s.requirements << "git"
+
+  s.files = ["README.markdown", "Rakefile", "bin/monk", "lib/monk/logger.rb", "lib/monk/reloader.rb", "lib/monk/settings.rb", "lib/monk.rb", "monk.gemspec", "test/integration_test.rb", "test/sinatra_test.rb"]
+end

data/test/integration_test.rb

@@ -0,0 +1,30 @@
+require "rubygems"
+require "contest"
+require "open3"
+
+BINARY = File.expand_path(File.join(File.dirname(__FILE__), "..", "bin", "monk"))
+
+class TestMonk < Test::Unit::TestCase
+  context "monk init" do
+    def monk(args = nil)
+      out, err = nil
+
+      Open3.popen3("ruby -rubygems #{BINARY} #{args}") do |stdin, stdout, stderr|
+        out = stdout.read
+        err = stderr.read
+      end
+
+      [out, err]
+    end
+
+    should "create a skeleton app with all tests passing" do
+      Dir.chdir("/tmp") do
+        FileUtils.rm_rf("monk-test")
+
+        out, err = monk("init monk-test")
+        assert out[/create.* monk-test/]
+        assert !File.directory?("monk-test/.git")
+      end
+    end
+  end
+end

data/test/sinatra_test.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/helper'
+
+class SinatraTest < Test::Unit::TestCase
+  it 'creates a new Sinatra::Base subclass on new' do
+    app =
+      Sinatra.new do
+        get '/' do
+          'Hello World'
+        end
+      end
+    assert_same Sinatra::Base, app.superclass
+  end
+end

metadata

@@ -1,30 +1,61 @@
 --- !ruby/object:Gem::Specification 
 name: monk
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
-- TBD
+- Damian Janowski
+- Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-07-17 00:00:00 -03:00
+date: 2009-07-22 00:00:00 -03:00
 default_executable: 
-dependencies: []
-
-description: TBD
-email: TBD
-executables: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: wycats-thor
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.11"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: dependencies
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.5
+    version: 
+description: Monk is a glue framework for web development. It means that instead of installing all the tools you need for your projects, you can rely on a git repository and a list of dependencies, and Monk will care of the rest. By default, it ships with a Sinatra application that includes Contest, Stories, Webrat, Ohm and some other niceties, along with a structure and helpful documentation to get your hands wet in no time.
+email: 
+- djanowski@dimaion.com
+- michel@soveran.com
+executables: 
+- monk
 extensions: []
 
 extra_rdoc_files: []
 
-files: []
-
+files: 
+- README.markdown
+- Rakefile
+- bin/monk
+- lib/monk/logger.rb
+- lib/monk/reloader.rb
+- lib/monk/settings.rb
+- lib/monk.rb
+- monk.gemspec
+- test/integration_test.rb
+- test/sinatra_test.rb
 has_rdoc: true
-homepage: 
+homepage: http://monkrb.com
 licenses: []
 
 post_install_message: 
@@ -44,12 +75,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version 
       version: "0"
   version: 
-requirements: []
-
-rubyforge_project: 
+requirements: 
+- git
+rubyforge_project: monk
 rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
-summary: TBD
+summary: Monk, the glue framework
 test_files: []