happy 0.1.0.pre20 → 0.1.0.pre21

data/example/config.ru

@@ -1,19 +1,26 @@
+# Just run this script through the 'rackup' command.
+
 lib_path = File.expand_path("#{File.dirname(__FILE__)}/../lib")
 $LOAD_PATH.unshift lib_path unless $LOAD_PATH.include?(lib_path)
 
 require 'happy'
-require 'cgi'
 
-class TestApp < Happy::Controller
-  def examples; @examples ||= {}; end
+# Controllers are the core building blocks of Happy applications.
+# They're also just Rack apps, so in any Happy app, you will
+# declare at least a "root" controller class and run that through Rack.
 
-  def example(name, path_name = nil, &blk)
-    path_name ||= name.parameterize
-    examples[name] = path_name
+class TestApp < Happy::Controller
 
-    # Create a path containing the example's code block
-    path(path_name, &blk)
-  end
+  # A controller's most important method is #route. Whenever a request hits
+  # your application, a new instance of your root controller class is
+  # created, and its #route method is called.
+  #
+  # This method can be as simple or complex as you like. In this example
+  # application, it wraps around a couple of annotated Happy examples.
+  # Usually, you'd use the #path method to specify code to be executed if
+  # a certain path was requested; in this app, we're using a custom #example
+  # method, that does the same thing but also records the example in a hash
+  # so we can generated a "table of contents" in index.erb.
 
   def route
     example 'Returning just a string' do
@@ -25,6 +32,11 @@ class TestApp < Happy::Controller
       serve! "I'm not being served, since the above call to #serve! halted processing."
     end
 
+    example 'Content-type' do
+      content_type 'text/css'
+      "/* I'm CSS! */\n\nbody { color: red }\n"
+    end
+
     example 'Path parameters' do
       path 'hello' do
         path :name do
@@ -100,6 +112,16 @@ class TestApp < Happy::Controller
 
     render 'index.erb'
   end
+
+  def examples; @examples ||= {}; end
+
+  def example(name, path_name = nil, &blk)
+    path_name ||= name.parameterize
+    examples[name] = path_name
+
+    # Create a path containing the example's code block
+    path(path_name, &blk)
+  end
 end
 
 run TestApp

data/happy.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'happy-helpers', '~> 0.1.0.pre11'
   gem.add_dependency 'allowance', '>= 0.1.1'
 
-  gem.add_dependency 'happy-cli', '>= 0.1.0.pre1'
+  # gem.add_dependency 'happy-cli', '>= 0.1.0.pre1'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '~> 2.8'

data/lib/happy/controller/configurable.rb

@@ -3,17 +3,21 @@ module Happy
     module Configurable
       extend ActiveSupport::Concern
 
-      def config
-        self.class.config
+      def options
+        @options ||= self.class.options.dup
+      end
+
+      def set(k, v)
+        options[k.to_sym] = v
       end
 
       module ClassMethods
-        def config
-          @config ||= {}
+        def options
+          @options ||= {}
         end
 
         def set(k, v)
-          config[k.to_sym] = v
+          options[k.to_sym] = v
         end
       end
     end

data/lib/happy/controller/helpers.rb

@@ -2,9 +2,16 @@ require 'happy-helpers'
 
 module Happy
   class Controller
+    # A collection of useful helper methods.
+    #
     module Helpers
+      # Load a whole bunch of helpers fromi HappyHelpers. This includes stuff
+      # like url_for, link_to and more.
       include HappyHelpers::Helpers
 
+      # Renders "something". This method takes a closer look at what this
+      # "something" is and then dispatches to a more specific method.
+      #
       def render(what, options = {}, &blk)
         case what
           when NilClass   then ''
@@ -14,11 +21,15 @@ module Happy
         end
       end
 
+      # Render a template from the controller's view folder.
+      #
       def render_template(name, variables = {}, &blk)
-        path = @controller ? @controller.config[:views] : './views'
+        path = options[:views] || './views'
         HappyHelpers::Templates.render(File.join(path, name), self, variables, &blk)
       end
 
+      # Render a resource.
+      #
       def render_resource(resource, options = {})
         # build name strings
         singular_name = resource.class.to_s.tableize.singularize

data/lib/happy/controller.rb

@@ -24,7 +24,9 @@ module Happy
     include Permissions
     include Helpers
 
-    attr_reader :options, :env, :unprocessed_path, :processed_path
+    attr_reader :env
+
+    CASCADING_OPTIONS = [:views]
 
     # Creates a new instance of {Controller}. When a block is provided,
     # it is run against the new instance, allowing custom controller classes
@@ -35,7 +37,7 @@ module Happy
     # @param options [Hash]
     #   Controller options.
     #
-    def initialize(env_or_parent = {}, options = {}, &blk)
+    def initialize(env_or_parent = {}, opts = {}, &blk)
       if env_or_parent.is_a?(Happy::Controller)
         @parent_controller = env_or_parent
         @env = @parent_controller.env
@@ -47,7 +49,15 @@ module Happy
         @processed_path  = []
       end
 
-      @options = options
+      # Augment this instance's options hash with the options given to this constructor
+      options.merge!(opts)
+
+      # Copy missing options from our parent
+      if @parent_controller
+        CASCADING_OPTIONS.each do |opt|
+          options[opt] ||= @parent_controller.options[opt]
+        end
+      end
 
       # Save a copy of the current path as this controller's root path.
       @root_url = processed_path.join('/')
@@ -67,6 +77,8 @@ module Happy
 
   protected
 
+    attr_reader :unprocessed_path, :processed_path
+
     def root_url(*extras)
       url_for(@root_url, extras)
     end

data/lib/happy/extras/resources.rb

@@ -92,10 +92,8 @@ module Happy
         end
 
         def route
-          @options = {
-            :singular_name => options[:class].to_s.tableize.singularize,
-            :plural_name   => options[:class].to_s.tableize.pluralize
-          }.merge(@options)
+          options[:singular_name] ||= options[:class].to_s.tableize.singularize
+          options[:plural_name]   ||= options[:class].to_s.tableize.pluralize
 
           path options[:plural_name] do
             get('new') { do_new }

data/lib/happy/version.rb

@@ -1,3 +1,3 @@
 module Happy
-  VERSION = "0.1.0.pre20"
+  VERSION = "0.1.0.pre21"
 end

data/spec/controller/configurable_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+module Happy
+  describe Controller::Configurable do
+    class TestController < Happy::Controller
+      set :foo, 'bar'
+    end
+
+    describe '.set' do
+      it 'sets a class-level option' do
+        TestController.options[:foo].should == 'bar'
+      end
+    end
+
+    describe '#set' do
+      before do
+        @instance = TestController.new
+        @instance.set :foo, 'baz'
+      end
+
+      it 'sets an instance-level option, overriding the class default' do
+        @instance.options[:foo].should == 'baz'
+      end
+
+      it "doesn't modify the class-level default option" do
+        TestController.options[:foo].should == 'bar'
+      end
+    end
+
+    describe 'class-level options' do
+      it 'are the defaults for instance-level options' do
+        TestController.new.options[:foo].should == 'bar'
+      end
+    end
+
+    describe 'cascading options' do
+      class OuterController < Controller
+        set :views, './foo/'
+        set :foo, 'bar'
+      end
+
+      class InnerController < Controller
+      end
+
+      it "are copied from the parent controller if necessary" do
+        @instance = InnerController.new(OuterController.new)
+        @instance.options[:views].should == './foo/'
+        @instance.options[:foo].should be_nil
+      end
+    end
+
+    describe 'options passed to the initializer' do
+      it "override default options" do
+        @instance = TestController.new({}, :foo => 'baz')
+        @instance.options[:foo].should == 'baz'
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: happy
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre20
+  version: 0.1.0.pre21
   prerelease: 6
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70246363046260 !ruby/object:Gem::Requirement
+  requirement: &70146774651160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70246363046260
+  version_requirements: *70146774651160
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70246363043080 !ruby/object:Gem::Requirement
+  requirement: &70146774650120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70246363043080
+  version_requirements: *70146774650120
 - !ruby/object:Gem::Dependency
   name: happy-helpers
-  requirement: &70246363042320 !ruby/object:Gem::Requirement
+  requirement: &70146774648720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.1.0.pre11
   type: :runtime
   prerelease: false
-  version_requirements: *70246363042320
+  version_requirements: *70146774648720
 - !ruby/object:Gem::Dependency
   name: allowance
-  requirement: &70246363058000 !ruby/object:Gem::Requirement
+  requirement: &70146774646980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,21 +54,10 @@ dependencies:
         version: 0.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *70246363058000
-- !ruby/object:Gem::Dependency
-  name: happy-cli
-  requirement: &70246363056880 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.1.0.pre1
-  type: :runtime
-  prerelease: false
-  version_requirements: *70246363056880
+  version_requirements: *70146774646980
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70246363056380 !ruby/object:Gem::Requirement
+  requirement: &70146774662260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70246363056380
+  version_requirements: *70146774662260
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70246363055680 !ruby/object:Gem::Requirement
+  requirement: &70146774660060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +76,10 @@ dependencies:
         version: '2.8'
   type: :development
   prerelease: false
-  version_requirements: *70246363055680
+  version_requirements: *70146774660060
 - !ruby/object:Gem::Dependency
   name: rspec-html-matchers
-  requirement: &70246363054880 !ruby/object:Gem::Requirement
+  requirement: &70146774658460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70246363054880
+  version_requirements: *70146774658460
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70246363054000 !ruby/object:Gem::Requirement
+  requirement: &70146774657580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70246363054000
+  version_requirements: *70146774657580
 - !ruby/object:Gem::Dependency
   name: watchr
-  requirement: &70246363053540 !ruby/object:Gem::Requirement
+  requirement: &70146774656440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +109,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70246363053540
+  version_requirements: *70146774656440
 description: A happy little toolkit for writing web applications.
 email:
 - hendrik@mans.de
@@ -161,6 +150,7 @@ files:
 - lib/happy/version.rb
 - spec/controller/actions_spec.rb
 - spec/controller/cascadable_spec.rb
+- spec/controller/configurable_spec.rb
 - spec/controller/routing_spec.rb
 - spec/controller_spec.rb
 - spec/happy_spec.rb
@@ -192,6 +182,7 @@ summary: A happy little toolkit for writing web applications.
 test_files:
 - spec/controller/actions_spec.rb
 - spec/controller/cascadable_spec.rb
+- spec/controller/configurable_spec.rb
 - spec/controller/routing_spec.rb
 - spec/controller_spec.rb
 - spec/happy_spec.rb