RubyGems - sharp - Versions diffs - 0.3.1 → 0.3.2 - Mend

sharp 0.3.1 → 0.3.2

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 (7) hide show

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f14fd10ff351041624cc62b49aff7992cebeaf97
+  data.tar.gz: 68c4c6646f5a5b7602b4e65e85714553bbf2e511
+SHA512:
+  metadata.gz: 48f0fb545bbae6faee5fe3e3d0918e07870debc8a14c897757555c32902386e6c21194c014d946669d12c6389227a3e5b70449b3ec4f64678dbec04ce5801e26
+  data.tar.gz: f4390112607d781dc05580b604b70856515263d55b26766ba3bde1a4de7026419e423b537cad1e2382dc0ae5075de79afbb400af2d11473990add70290de98ed

data/.rvmrc CHANGED Viewed

	@@ -1 +1 @@
1	- rvm 1.9.3@sharp --create
1	+ rvm 2.0.0@sharp --create

data/TUTORIAL.md CHANGED Viewed

@@ -111,6 +111,8 @@ end
 What this means is if the request is a `GET` and the path is just `/`, call the `RootAction` to generate the response.  We'll go into routing in more detail later, but for now, let's take a look at what the `RootAction` does.
+The Sharp router is a [Rack::Router][rack-router], so for more information on how the router works, take a look at the docs for [Rack::Router][rack-router].
 # Actions
 So as we've seen, the router determines what action should respond to a request, and it is the job of an action to generate the response.  If we look at the `RootAction`, which is defined in `app/actions/root_action.rb`, we see this:
@@ -122,6 +124,8 @@ end
 Huh, not much going on there, is there?  That's because the default behavior of an action is to render the template that matches the name of the action.  In this case, the action is `app/actions/root_action.rb`, so the template will be `templates/root.erb`.  We'll cover actions in more depth later, but let's take a look at the template next.
+But in case you are curious now, Sharp actions are [Rack::Action][rack-action], so you can read up on the documentation for [Rack::Action][rack-action] to find out more about what you can do with actions.
 # Templates
 There is what the template that is used to generate our response, `templates/root.erb`, looks like:
@@ -156,7 +160,7 @@ If you make a request to your application now, you'll see this:
 As you can see, the Ruby code contained between the `<%= -%>` was evaluated and the result what the current year, which was included into the response.
-One thing to notice is that you didn't have to restart your application, the changes were picked up automatically.  This is because we used `shotgun` to start the application, which handles automatically reloading the application between requests for us.
+One thing to notice is that you didn't have to restart your application, the changes were picked up automatically.  This is because we used [shotgun][shotgun] to start the application, which handles automatically reloading the application between requests for us.
 One question you may be asking is where did the `<html>`, `<head>` and `<body>` tags come from? `templates/root.erb` just contains the snippet that ends up in the `<body>`.  The answer is layouts, which is the topic we'll introduce next.
@@ -178,10 +182,119 @@ In many web application, the same `<head>` and basic structure within the `<body
 The tag `<%= render main -%>` is used to specify where the main content for the view should go.  In fact, `render` is a generic method that you can use render any template from within another.  `main` is a local variable that has the name of the template for the current view, which is `"root"` in this case.
+# Views
+In your application, you will most likely want to prepare some data in the action and make it available for rendering in the template.  Taking our previous example of dynamically generating the year in the template, let's move the "logic" of generating that into the action.  Edit `app/actions/root_action.rb` to look like this:
+``` ruby
+class RootAction < ApplicationAction
+  def respond
+    @now = Time.now
+    view[:current_year] = @now.year
+    super
+  end
+end
+```
+Now we can modify the template to refer to it like this:
+``` erb
+<h1>Hello, World</h1>
+<footer>
+  &copy; Copyright <%= current_year -%>
+</footer>
+```
+Instance variables of the action are not accessible in the template, so the following would not work:
+``` erb
+<h1>Hello, World</h1>
+<footer>
+  &copy; Copyright <%= @now.year -%>
+</footer>
+```
+If you have data that you want available in the template, you must assign to the view, as we did with `current_year` in this example.
+# Filters
+Sharp actions support before filters, which are methods that execute before the `response` method.  Using before filters, we could write the previous example like this:
+``` ruby
+class RootAction < ApplicationAction
+  before_filter :load_year
+  def load_year
+    view[:current_year] = Time.now.year
+  end
+end
+```
+More common usage of before filter is to check for some pre-existing conditions and possibly render a response if they are not met:
+``` ruby
+class RootAction < ApplicationAction
+  before_filter :require_password
+  def require_password
+    unless params[:password] == 'secret'
+      redirect_to '/access_denied'
+    end
+  end
+end
+```
+In this example, unless there is a param password equal to "secret", a redirect response will be generate, which prevents the action from calling the respond method and instead returns the redirect response.
+# Custom Views
+Another way to make data available to the templates in Sharp is by creating a view object that corresponds to your action.  Create a file at `app/views/root_view.rb` that looks like this:
+``` ruby
+class RootView < ApplicationView
+  def current_year
+    Time.now.year
+  end
+end
+```
+You can now return the `RootAction` to it's original default state:
+``` ruby
+class RootAction < ApplicationAction
+end
+```
+If you hit the root URL in your browser or with curl now, you will see the same result.  It is a good practice to build up a hierarchy of view objects and use inheritance to share functionality between related views.
+The functionality for the view layer in Sharp is provided by [Curtain][curtain].  If you are looking for more information on what you can do with views, take a look at the documentation for [Curtain][curtain].
+# Console
+You can get an IRB console with your sharp application loaded by running this command:
+    $ sharp console
+From within the console, there are a few methods to help you work with your Sharp application.  First, if you would like to see what action a request would route to, you can do this:
+    > Sharp.route :get, '/'
+     => RootAction
+In this example, `:get` is the request method and `'/'` is the path you want to check.  As you can see, it returns the rack app that the route matches.  It returns nil if there is no match.
+You can also call an action through the route and get the rack response that it generates:
+    > Sharp.get '/'
+     => [200, {"Content-Type"=>"text/html", "Content-Length"=>"171"}, #<Rack::BodyProxy...
 # More To Come
 Sharp is still in the early stages of development, so keep checking back for updates on how to do more advanced things with Sharp.
 [jquery]: http://jquery.com
 [bootstrap]: http://twitter.github.com/bootstrap
-[bundler]: http://gembundler.com
+[bundler]: http://gembundler.com
+[rack-router]: https://github.com/pjb3/rack-router#usage
+[rack-action]: https://github.com/pjb3/rack-action#usage
+[curtain]: https://github.com/pjb3/curtain#usage
+[shotgun]: https://github.com/rtomayko/shotgun

data/lib/sharp.rb CHANGED Viewed

@@ -4,6 +4,7 @@ require 'logger'
 require 'pathname'
 require 'rack-action'
 require 'rack-router'
+require 'stringio'
 require 'yaml'
 require 'sharp/action'
 require 'sharp/config'
@@ -12,7 +13,6 @@ require 'sharp/generator'
 require 'sharp/version'
 module Sharp
   class << self
     attr_reader :app
     delegate :logger, :boot, :root, :router, :env, :config, :route, :get, :post, :put, :delete, :head, :to => :app
@@ -32,6 +32,18 @@ module Sharp
   end
   class Application
+    DEFAULT_ENV = {
+      "SCRIPT_NAME" => "",
+      "SERVER_NAME" => "localhost",
+      "SERVER_PORT" => "80",
+      "HTTP_HOST" => "localhost",
+      "HTTP_ACCEPT" => "*/*",
+      "HTTP_USER_AGENT" => "Sharp #{VERSION}",
+      "rack.input" => StringIO.new,
+      "rack.errors" => StringIO.new,
+      "rack.url_scheme" => "http"
+    }.freeze
     attr_reader :root, :router
     def self.boot(root)
@@ -40,13 +52,6 @@ module Sharp
       app
     end
-    # Generates a Rack env Hash
-    def self.env(method, path, env={})
-      env.merge(
-        'REQUEST_METHOD' => method.to_s.upcase,
-        'PATH_INFO' => path)
-    end
     def initialize(root)
       @root = Pathname.new(root)
     end
@@ -57,9 +62,7 @@ module Sharp
       else
         pre_initialization
         load_i18n
-        load_lib
-        load_models
-        load_actions
+        load_load_path
         load_routes
         post_initialization
         finish_boot
@@ -70,6 +73,15 @@ module Sharp
       @router ||= Rack::Router.new
     end
+    # Generates a Rack env Hash
+    def self.env(method, path, query={}, env={})
+      DEFAULT_ENV.merge(env || {}).merge(
+        'REQUEST_METHOD' => method.to_s.upcase,
+        'PATH_INFO' => path,
+        'QUERY_STRING' => query.to_param,
+        'rack.input' => StringIO.new)
+    end
     def route(method, path, env={})
       router.match(self.class.env(method, path, env={}))
     end
@@ -131,7 +143,12 @@ module Sharp
       @config ||= Sharp::Config.new(env, Dir[root.join("config/*.yml")])
     end
+    def load_path
+      @load_path ||= %w[app/lib app/models app/actions app/views]
+    end
     protected
     def pre_initialization
       Dir.glob(root.join("app/initializers/pre/*.rb")) {|file| load file }
     end
@@ -144,21 +161,11 @@ module Sharp
       end
     end
-    # TODO: Make an Array of load paths that you can add to that these are just part of
-    def load_lib
-      $:.unshift(root.join("app/lib"))
-      Dir.glob(root.join("app/lib/*.rb")) {|file| require file }
-    end
-    def load_models
-      $:.unshift(root.join("app/models"))
-      Dir.glob(root.join("app/models/*.rb")) {|file| require file }
-    end
-    def load_actions
-      Rack::Action.logger = logger
-      $:.unshift(root.join("app/actions"))
-      Dir.glob(root.join("app/actions/*.rb")) {|file| require file }
+    def load_load_path
+      load_path.each do |path|
+        $:.unshift(root.join(path))
+        Dir.glob(root.join("#{path}/*.rb")) {|file| require file }
+      end
     end
     def load_routes
@@ -172,6 +179,5 @@ module Sharp
     def finish_boot
       @booted = true
     end
   end
 end

data/lib/sharp/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Sharp
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/sharp.gemspec CHANGED Viewed

@@ -2,7 +2,7 @@
 Gem::Specification.new do |gem|
   gem.name          = "sharp"
-  gem.version       = "0.3.1"
+  gem.version       = "0.3.2"
   gem.authors       = ["Paul Barry"]
   gem.email         = ["mail@paulbarry.com"]
   gem.description   = %q{A Ruby and Rack-based web framework}

metadata CHANGED Viewed

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sharp
 version: !ruby/object:Gem::Version
-  version: 0.3.1
-  prerelease:
+  version: 0.3.2
 platform: ruby
 authors:
 - Paul Barry
@@ -14,65 +13,57 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: curtain
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-router
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-action
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A Ruby and Rack-based web framework
@@ -124,27 +115,26 @@ files:
 - template/vendor/assets/stylesheets/.gitkeep
 homepage: http://github.com/pjb3/sharp
 licenses: []
+metadata: {}
 post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 1.8.25
+rubygems_version: 2.0.0
 signing_key:
-specification_version: 3
+specification_version: 4
 summary: A Ruby and Rack-based web framework
 test_files: []
 has_rdoc: