campo 0.9.0 → 0.9.1

data/CHANGES.markdown

@@ -1,3 +1,10 @@
+## v0.9.1 16th of December 2012 ##
+
+* `labelled` can now take an attributes hash, so: `.labelled("Favourite tea:", class: "list")` will output `%label{ class: "list", for: "teas",  }`
+
+----
+
+
 ## v0.9.0 16th of June 2012 ##
 
 * Updated the README with info on using plugins, and how to contribute.

data/Gemfile

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 group :development do
   gem "rake"
   gem "yard"
-  gem "maruku"
+  gem "rdiscount"
   gem "wirble"
   gem "reek"
 end

data/README.markdown

@@ -1,28 +1,34 @@
-[![Build Status for development branch](https://secure.travis-ci.org/yb66/Campo.png?branch=develop)](http://travis-ci.org/yb66/Campo)
-
-# Campo #
+## Campo ##
 
 A static dynamic form builder into haml. Yep, static _and_ dynamic. Use it to statically create a form into haml, but you may notice it's taken advantage of haml's "add a hash to the front of the attributes and it'll get merged" property. [See Haml docs for more](http://haml-lang.com/docs/yardoc/file.HAML_REFERENCE.html#attribute_methods). More on that below.
 
 Btw, I'll be using this with Sinatra, if you're using Rails you'll need to work out how that's done as I don't know.
 
-## Note! ##
+### Build status ###
+
+Master branch:
+[![Build Status for development branch](https://secure.travis-ci.org/yb66/Campo.png?branch=master)](http://travis-ci.org/yb66/Campo)
+
+Develop branch:
+[![Build Status for development branch](https://secure.travis-ci.org/yb66/Campo.png?branch=develop)](http://travis-ci.org/yb66/Campo)
+
+### Note! ###
 
 As always, keep in mind this is an open source project (licence below) and you can contribute! If you find a problem or would like a feature changed or added, let me know, or even better, fork the project and send me a pull request. See the "Contributing" section for some notes on how to do that.
 
-## Double note! ##
+### Double note! ###
 
 I use Campo myself, and I'm trying to improve it. As I don't want to push new stuff out before I've had a chance to give it a whirl and see if it makes sense and works (through experience, specs aren't everything) I'll have several versions of this up here, some unreleased. I tend to append a 'b' to the end of an unreleased version. Please make sure you're reading the documentation for the version you're using!
 
-## Version numbers ##
+### Version numbers ###
 
 You'll notice this library is well past version 0.0.1. Some people take this to mean something like "it works brilliantly", but in fact, I'm attempting to use the [semver standard](http://semver.org/). In essence, it tells you about changes to the API, not about code quality - that's what the specs/tests are for. It's worth a read.
 
-## Why write this? ##
+### Why write this? ###
 
 However nice Haml is, it's still a lot of effort to build a form. If you've got lots of forms it's worse. The long term plan is to link this in to Sequel.
 
-## Example! ##
+### Example! ###
 
 Here's an example form:
 
@@ -105,7 +111,7 @@ and the output:
         %input{ atts[:Save], tabindex: "#{@campo_tabindex += 1}", id: "Save", type: "submit", value: "Save",  }
 
 
-## Haml attributes ##
+### Haml attributes ###
 
 Back to the dynamic attributes mentioned earlier. What does this mean? You can pass in a local to dynamically alter the form based on server side logic.
 
@@ -215,7 +221,7 @@ You can do this with any kind of attribute you wish to add. For example:
 But I doubt your name is Noel Gallagher, which makes this a spurious example.
 
     
-## Be selective ##
+### Be selective ###
     
     opts = [
       ["ceylon"], 
@@ -241,7 +247,7 @@ Output:
         %option{ atts[:teas_english_breakfast], id: "teas_english_breakfast", value: "english_breakfast", selected: "selected", name: "teas",  }English breakfast
         %option{ atts[:teas_earl_grey], id: "teas_earl_grey", value: "earl_grey", name: "teas",  }Earl grey
         
-## Pass a hash ##
+### Pass a hash ###
 
     opts = {
       "ceylon"=>"Ceylon",
@@ -284,7 +290,7 @@ Output:
         %option{ atts[:teas_english_breakfast], id: "teas_english_breakfast", value: "english_breakfast", selected: "selected", name: "teas",  }English Breakfast
         %option{ atts[:teas_earl_grey], id: "teas_earl_grey", value: "earl_grey", name: "teas",  }Earl Grey
 
-## Adding in helpers ##
+### Adding in helpers ###
 
 If you want to use helpers in the attributes, like sinatra's `uri` helper, then add a double-quote to the front:
 
@@ -305,7 +311,7 @@ outputs:
       
 Although, if you forget the "=" sign it will add it for you.
 
-## And literals ##
+### And literals ###
 
 `bit_of_ruby` is really just a literal with a shortcut. Here are some examples using literals:
 
@@ -352,13 +358,13 @@ You can use literals to wrap forms in divs too:
         %p= "I like tea!"
 
         
-## tabindex ##
+### tabindex ###
 
 Each field gets `@campo_tabindex += 1` added to its attributes. This will generate a tabindex easily for you.
 
 Since it's an instance variable it can be passed through easily to nested partials and the count will still be right.
 
-## Blocks ##
+### Blocks ###
 
 Most fields will accept a block, so you can nest whatever you like. Generally I just use this for forms, fieldsets and selects (and those have specs) but if you want to try something new, do it! Let me know if it breaks. You don't have to use the `|var|` notation unless you feel it's helpful.
 
@@ -396,7 +402,7 @@ Output:
             Blah
             %input{ atts[:blah], tabindex: "#{@campo_tabindex += 1}", id: "blah", type: "text", name: "blah",  }
 
-## Plugins ##
+### Plugins ###
 
 I've written a couple of plugins. If you wish to write one yourself you'll need to look for the code for now until I write some proper instructions.
 
@@ -504,7 +510,7 @@ To contribute some code:
 * Shrug and get on with your life when it doesn't arrive, but know you helped quite a few people in their life, even in a small way - 1000 raindrops will fill a bucket!
 
 
-## Licence ##
+### Licence ###
 
 This is under the MIT Licence.
 

data/lib/campo/campo.rb

@@ -106,6 +106,8 @@ module Campo
     #     # Select using chain of options
     #     form.select("bands").option("Suede").option("Blur").option("Oasis").option("Echobelly").option("Pulp").option("Supergrass").with_default.labelled("Favourite band:")
     #
+    #     select( "breads", {opts: [[1, "White"],[2,"Malted"],[3,"Black"],[4,"Wholemeal"], [5,"Rye"] ] })
+    #
     # @see Select#initialize
     def select( *args, &block )
       select = Campo::Select.new( *args, &block )
@@ -279,12 +281,14 @@ module Campo
 
 
     # Bit of a convenience method for adding a label around any element.
-    # @param [String] inner The text for the label.
+    # @param [String] :inner The text for the label.
+    # @param [Hash] :attributes Attributes for the label.
     # @return [Base]
-    def labelled( inner=nil )
+    # @see Label#initialize
+    def labelled( inner=nil, attributes={} )
       inner ||= self.attributes[:name].gsub(/\[\]/, "").gsub("_"," ").capitalize
       parent = self.parent
-      label = Label.new( %Q!#{@attributes[:id]}!, inner ) << self
+      label = Label.new( %Q!#{@attributes[:id]}!, inner, attributes ) << self
       retval = if parent.nil?
         label
       else
@@ -460,7 +464,7 @@ module Campo
   
   class Haml_Ruby_Insert < Base
     def initialize( s )
-      raise ArgumentError, "you may only pass a string to Haml_Ruby_Insert/bit_of_ruby" unless s.kind_of?( String )
+      fail ArgumentError, "you may only pass a string to Haml_Ruby_Insert/bit_of_ruby" unless s.kind_of?( String )
       super( nil ) # no name needed
       
       # @todo Don't enforce the equals sign, as a hyphen is also valid for adding a bit of ruby. Raise an exception
@@ -494,12 +498,18 @@ module Campo
     end
   end # Literal
   
-  
+
+  # For building 'select' tags.
   class Select < Base
+
+    # @param [String] :name
+    # @param [Hash] :params
+    # option params [Hash] :attributes
+    # option params [#to_s] :haml_insert
     def initialize( name, params={} )
-      opts = params[:opts] || []
-      attributes = params[:attributes] || {}
-      haml_insert = params[:haml_insert] || nil
+      opts = params.fetch :opts, []
+      attributes = params.fetch :attributes, {}
+      haml_insert = params.delete :haml_insert
       
       super( name, { tabindex: %q!#{@campo_tabindex += 1}! }.merge(attributes) )
       
@@ -515,6 +525,10 @@ module Campo
     end # initialize
 
 
+    # @param [#to_s] value The value for attribute 'value'.
+    # @param [#to_s] inner The display text.
+    # @param [true,false,nil] selected Whether the field is selected. Defaults to false.
+    # @param [Hash] attributes Hash of attributes. They'll get added to the element.
     # @example (see Convenience#select)  
     def option( *args )
       value = args.shift
@@ -528,7 +542,7 @@ module Campo
     
     # Adds a default selection to a select list. By default it is disabled.
     # @param [String,nil] The display string for the option. Default is "Choose one:".
-    # @param [Hash,nil] attributes Attributes for the option. Defaults to {disabled: "disabled"}, pass in an empty hash to override (or a filled one), or nil for the default.
+    # @param [Hash,nil] attributes Attributes for the option. Defaults to Hash[ :disabled => "disabled" ], pass in an empty hash to override (or a filled one), or nil for the default.
     # @example 
     #     As a default:
     #     form.select("teas").with_default.option("ceylon")

data/lib/campo/version.rb

@@ -1,3 +1,3 @@
 module Campo
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

data/spec/campo_spec.rb

@@ -40,7 +40,7 @@ STR
       context "Given no form" do
         context "When given a select field with options" do
           let(:expected) { %q!
-%label{ for: "teas",  }
+%label{ class: "list", for: "teas",  }
   Favourite tea:
   %select{ atts[:teas], tabindex: "#{@campo_tabindex += 1}", id: "teas", name: "teas",  }
     %option{ atts[:teas_default], id: "teas_default", value: "", disabled: "disabled", name: "teas",  }Choose one:
@@ -51,7 +51,7 @@ STR
           }
           let(:tag) {
             select = Campo::Select.new( "teas" )
-            tag = select.with_default.option("ceylon").option("breakfast").option("earl grey").labelled("Favourite tea:") 
+            tag = select.with_default.option("ceylon").option("breakfast").option("earl grey").labelled("Favourite tea:", class: "list") 
             tag
           }
           subject { Campo.output tag, :partial=>true }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: campo
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-16 00:00:00.000000000 Z
+date: 2012-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Form builder for Haml
@@ -121,3 +121,4 @@ test_files:
 - spec/plugins_spec.rb
 - spec/spec_helper.rb
 - spec/support/matchers/items.rb
+has_rdoc: