formic 0.1.0

data/lib/formic/base.rb

@@ -0,0 +1,65 @@
+module Formic
+  class Base
+    attr_reader   :page, :options
+    attr_accessor :template, :content
+
+    def self.default_template given_default_template
+      @template = given_default_template
+    end
+
+    def self.template
+      @template || self.superclass.template
+    end
+
+    def template
+      return @template || self.class.template
+    end
+
+    def initialize page, *args, &block
+      @page = page
+      @options = {:class => []}
+
+      _initialize *args, &block
+      @options[:class].unshift( self.class.to_s.split('::').last.underscore )
+      self.formics.unshift self
+    end
+
+    def to_s
+      rendered = self.page.render :partial => self.template, :locals => {:element => self}
+      self.formics.shift
+      return rendered
+    end
+
+    def method_missing method, *args, &block
+      _initialize *args, &block
+      self.options[:class].push method.to_s
+      return self
+    end
+
+    def _initialize options={}, &block
+      self.merge_options options
+      @content = block if block_given?
+      return self
+    end
+
+    def has_class? classname
+      return self.options[:class].include? classname
+    end
+
+    def formics
+      @page.instance_variable_set(:@formics, []) unless @page.instance_variable_get(:@formics)
+      @page.instance_variable_get(:@formics)
+    end
+
+    def merge_options new_options
+      classes = [@options[:class], new_options[:class]].reject {|element| element.nil?}
+      classes = classes.flatten.join(' ').split(' ').uniq
+      @options.merge!(new_options).merge!(:class => classes)
+    end
+
+    def options
+      @options[:class] = @options[:class].uniq
+      return @options
+    end
+  end
+end

data/lib/formic/button.rb

@@ -0,0 +1,22 @@
+module Formic
+  class Button < Base
+    default_template 'formic/default/button'
+
+    attr_reader :label
+    def _initialize label=nil, options={}, &block
+      if label.instance_of? Hash
+        options = label
+        label = nil
+      end
+
+      super options, &block
+      @label = label
+    end
+
+    def method_missing method, label=nil, options={}, &block
+      super method, label, options{}, &block
+      @label ||=  method.to_s.underscore.titleize
+      return self
+    end
+  end
+end

data/lib/formic/checkbox.rb

@@ -0,0 +1,9 @@
+module Formic
+  class Checkbox < Input
+    def _initialize name=nil, options={}, &block
+      super
+      self.options[:type] = 'checkbox'
+      return self
+    end
+  end
+end

data/lib/formic/file.rb

@@ -0,0 +1,8 @@
+module Formic
+  class File < Input
+    def initialize page, name=nil, options={}, &block
+      super
+      self.options[:type] = 'file'
+    end
+  end
+end

data/lib/formic/form.rb

@@ -0,0 +1,69 @@
+module Formic
+  class Form < Base
+    default_template 'formic/default/form'
+
+    attr_reader :model, :action
+
+    def _initialize options={}, &block
+      super options, &block
+      self.options[:method] ||= 'POST'
+    end
+
+    def put options={}, &block
+      self.options[:method ] = 'POST'
+      self.options[:_method] = 'PUT'
+      self.content = block if block_given?
+      return self
+    end
+
+    def create model, options={}, &block
+      options[:title] ||= "New #{model.class.to_s.underscore}".gsub('_', ' ').titleize
+      @action = :create
+
+      return _initialize_with_model(
+        model,
+        options[:action] || self.page.url_for(model),
+        "create_#{model.class.to_s.downcase}_form",
+        options,
+        &block
+      )
+    end
+
+    def edit model, options={}, &block
+      self.put
+
+      @action = :edit
+      options[:title] ||= "Edit #{model.class.to_s.underscore}".gsub('_', ' ').titleize
+      return _initialize_with_model(
+        model,
+        options[:action] || self.page.url_for(model),
+        "edit_#{model.class.to_s.downcase}_form",
+        options,
+        &block
+      )
+    end
+
+    def method_missing action, model, options={}, &block
+      @action = action
+      options[:title] ||= "#{action} #{model.class.to_s.underscore}".gsub('_', ' ').titleize
+      return _initialize_with_model(
+        model,
+        options[:action] || "#{self.page.url_for(model)}/#{action}",
+        "#{action}_#{model.class.to_s.downcase}_form",
+        options,
+        &block
+      )
+    end
+
+    def _initialize_with_model model, action, classname, options={}, &block
+      options[:title] ||= "#{action} #{model.class.to_s.underscore}".gsub('_', ' ').titleize
+      @model = model
+      self.merge_options(options)
+      self.options[:method] ||= 'POST'
+      self.options[:action] ||= action
+      self.options[:class].push classname
+      self.content = block if block_given?
+      return self
+    end
+  end
+end

data/lib/formic/helper.rb

@@ -0,0 +1,39 @@
+require 'formic'
+
+module Formic
+  module Helper
+    def self.formic_helper *names
+      names.each do |name|
+        define_method(name) { |*args, &block|
+          name = :menu if name == :menu_bar
+          klass = get_class(name)
+          object = klass.new(self, *args, &block)
+          return object
+        }
+      end
+    end
+
+    formic_helper(
+      :selection,
+      :input,
+      :password,
+      :checkbox,
+      :list,
+      :list_item,
+      :tab,
+      :form,
+      :tab_panel,
+      :button,
+      :textarea,
+    )
+
+    def get_class symbol
+      classname = ''
+      elements = symbol.to_s.split('_')
+      elements.each do |element|
+        classname += element.capitalize
+      end
+      return "Formic::#{classname}".constantize
+    end
+  end
+end

data/lib/formic/hidden.rb

@@ -0,0 +1,10 @@
+module Formic
+  class Hidden < Input
+    default_template 'formic/default/hidden'
+    def _initialize name=nil, options={}, &block
+      super
+      self.options[:type] = 'hidden'
+      return self
+    end
+  end
+end

data/lib/formic/input.rb

@@ -0,0 +1,41 @@
+module Formic
+  class Input < Base
+    default_template 'formic/default/input'
+
+    attr_reader :field
+
+    def label
+      return self.options[:label] if self.options[:label]
+      return @field.underscore.gsub('_', ' ').titleize
+    end
+
+    def _initialize name=nil, options={}, &block
+      if name.instance_of? Hash
+        options = name
+        name = nil
+      end
+
+      super options, &block
+      @field = name
+
+      if !options[:name]
+        if @field && self.form && self.form.model
+          self.options[:name] = "#{self.form.model.class.to_s.downcase}[#{name}]"
+          self.options[:value] ||= self.form.model.send(@field.to_sym)
+        elsif
+          self.options[:name] = name
+        end
+      end
+
+      return self
+    end
+
+    def form
+      self.formics.each do |element|
+        return element if element.instance_of? Formic::Form
+      end
+
+      return nil
+    end
+  end
+end

data/lib/formic/list.rb

@@ -0,0 +1,5 @@
+module Formic
+  class List < Base
+    default_template 'formic/default/list'
+  end
+end

data/lib/formic/list_item.rb

@@ -0,0 +1,13 @@
+module Formic
+  class ListItem < Base
+    default_template 'formic/default/list_item'
+
+    attr_reader :text
+
+    def _initialize text='', options={}, &block
+      super options, &block
+      @text = text
+      return self
+    end
+  end
+end

data/lib/formic/password.rb

@@ -0,0 +1,10 @@
+module Formic
+  class Password < Input
+    def _initialize name=nil, options={}, &block
+      super 
+      @options[:value] = ''
+      @options[:type] = 'password'
+      return self
+    end
+  end
+end

data/lib/formic/railtie.rb

@@ -0,0 +1,12 @@
+require 'formic/helper'
+module Formic
+  class Railtie < Rails::Railtie
+    initializer "formic.helper" do
+      ActionView::Base.send :include, Formic::Helper                                                                       
+    end
+
+    initializer "formic.template dir" do
+      ActionController::Base.append_view_path "#{::File.expand_path(::File.dirname(__FILE__))}/../../views"
+    end
+  end
+end

data/lib/formic/selection.rb

@@ -0,0 +1,5 @@
+module Formic
+  class Selection < Input
+    default_template 'formic/default/selection'
+  end
+end

data/lib/formic/tab.rb

@@ -0,0 +1,23 @@
+module Formic
+  class Tab < Base
+    default_template 'formic/default/tab'
+
+    attr_reader :title
+
+    def _initialize title='', options={}, &block
+      super options, &block
+      @title = title
+      self.tab_panel.tabs.push self
+      self.options[:id] ||= "#{title.downcase.gsub(' ', '_')}_tab"
+      return self
+    end
+
+    def tab_panel
+      self.formics.each do |element|
+        return element if element.instance_of? Formic::TabPanel
+      end
+
+      return nil
+    end
+  end
+end

data/lib/formic/tab_panel.rb

@@ -0,0 +1,12 @@
+module Formic
+  class TabPanel < Base
+    default_template 'formic/default/tab_panel'
+    attr_accessor :tabs
+
+    def _initialize options={}, &block
+      super
+      @tabs = []
+      return self
+    end
+  end
+end

data/lib/formic/textarea.rb

@@ -0,0 +1,5 @@
+module Formic
+  class Textarea < Input
+    default_template 'formic/default/textarea'
+  end
+end

data/lib/formic.rb

@@ -0,0 +1,17 @@
+require 'active_support'
+require 'active_support/all'
+require 'formic/base'
+require 'formic/form'
+require 'formic/input'
+require 'formic/file'
+require 'formic/hidden'
+require 'formic/checkbox'
+require 'formic/password'
+require 'formic/textarea'
+require 'formic/selection'
+require 'formic/button'
+require 'formic/tab_panel'
+require 'formic/tab'
+require 'formic/list'
+require 'formic/list_item'
+require 'formic/railtie' if defined?(Rails)

data/spec/formic/base_spec.rb

@@ -0,0 +1,148 @@
+require 'spec_helper'
+
+describe Formic::Base do
+  before(:each) do
+    @page = Object.new
+    @options = {:key => 'value'}
+    @block = Proc.new {}
+  end
+
+  context "#initilize" do
+    it "should be initialize with a options and a block" do
+      base = Formic::Base.new @page, @options, &@block
+      base.options.should == @options.merge(:class => ['base'])
+      base.content.should == @block
+    end
+
+    it "should not have content if block is not given" do
+      base = Formic::Base.new @options
+      base.content.should be_nil
+    end
+
+    it "register form to formics" do
+      base = Formic::Base.new @page, @options, &@block
+      base.formics.first.should == base
+    end
+  end
+
+  context "#default_template" do
+    before(:each) do
+      class Child < Formic::Base
+        default_template 'formic/child'
+      end
+
+      @child  = Child.new @page, @options
+    end
+
+    it "child class should be able to define default template" do
+      @child.template.should == 'formic/child'
+    end
+
+    it "object can have its own template" do
+      @child.template = 'form/child_different'
+      @child.template.should == 'form/child_different'
+    end
+
+    it "each child class should be able to define its own template" do
+      class AnotherChild < Formic::Base
+        default_template 'formic/anotherchild'
+      end
+
+      @child.template.should == 'formic/child'
+      another_child = AnotherChild.new @options
+      another_child.template.should == 'formic/anotherchild'
+    end
+
+    it "should have a class with the element class name" do
+      @child.options[:class].include?('child').should be_true
+    end
+  end
+
+  context "#to_s" do
+    before(:each) do
+      Formic::Base.default_template 'template'
+      @base = Formic::Base.new @page, @options, &@block
+
+      mock(@page).render(
+        :partial => 'template',
+        :locals => {:element => @base}
+      ) {'page_rendered'}
+
+      @result = @base.to_s
+    end
+
+    it "should render the page with the options" do
+      @result.should == 'page_rendered'
+    end
+
+    it "should unregister the element" do
+      @base.formics.first.should_not == @base
+    end
+  end
+
+  context "#has_class" do
+    it "should return true for correct class" do
+      base = Formic::Base.new(@page, {:class => 'somestle'})
+      base.has_class?('somestle').should be_true
+    end
+  end
+
+  context "#merge_options" do
+    before(:each) do
+      @base = Formic::Base.new @page, @options.merge(:title => 'title'), &@block
+      @base.merge_options({:class => 'hello', :title => 'new title'})
+    end
+
+    it "should add class" do
+      @base.options[:class].should =~ ['base', 'hello']
+    end
+
+    it "should override other attribute" do
+      @base.options[:title].should == 'new title'
+    end
+  end
+
+  context "#options" do
+    it "should remove duplication in option[:class]" do
+      @base = Formic::Base.new @page, :class => 'same same different'
+      @base.options[:class].should == ['base', 'same', 'different']
+    end
+  end
+
+  context "#method_missing" do
+    before(:each) do
+      @base = Formic::Base.new(@page, {:class => 'class_in_option'})
+      @base.something @options, &@block
+    end
+
+    it "should add the class" do
+      @base.should have_class ('something')
+    end
+
+    it "should have options" do
+      @base.options[:key].should == 'value'
+    end
+
+    it "should have content" do
+      @base.content.should == @block
+    end
+
+    it "should add the class" do
+      @base.should have_class ('something')
+    end
+
+    context "order of classes" do
+      it "should have default type has first" do
+        @base.options[:class].first.should == 'base'
+      end
+
+      it "should have class in option as second priority" do
+        @base.options[:class].second.should == 'class_in_option'
+      end
+
+      it "should have class in missing method as the last" do
+        @base.options[:class].last.should == 'something'
+      end
+    end
+  end
+end

data/spec/formic/button_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Formic::Button do
+  before(:each) do
+    @model = Object.new
+    stub(@page = Object.new).url_for(@model) {'/models/1'}
+    stub(@page).render
+
+    @options = {}
+    @block = Proc.new {}
+  end
+
+  context "#initialize" do
+    before(:each) do
+      @button = Formic::Button.new @page, 'name', @options, &@block
+    end
+
+    it "should have template formic/default/button" do
+      @button.template.should == 'formic/default/button'
+    end
+
+    it "should have class button" do
+      @button.should have_class 'button'
+    end
+
+    it "should set field value" do
+      @button.label.should == 'name'
+    end
+  end
+
+  context "#method_missing" do
+    before(:each) do
+      @button = Formic::Button.new @page
+      @result = @button.go_ahead @options, &@block
+    end
+
+    it "should have class as action" do
+      @button.options[:class].last.should == 'go_ahead'
+    end
+
+    it "should generate label as class" do
+      @button.label.should == 'Go Ahead'
+    end
+
+    it "should return the object" do
+      @result.should == @button
+    end
+
+    it "should use label if label is given" do
+      button = Formic::Button.new @page
+      result = @button.go_ahead 'Button Label', @options, &@block
+      result.label.should == 'Button Label'
+    end
+  end
+end

data/spec/formic/checkbox_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Formic::Checkbox do
+  before(:each) do
+    @model = Object.new
+    stub(@page = Object.new).url_for(@model) {'/models/1'}
+    stub(@page).render
+
+    @options = {}
+    @block = Proc.new {}
+  end
+
+  context "#checkbox" do
+    before(:each) do
+      @input = Formic::Checkbox.new @page, 'name', @options, &@block
+    end
+
+    it "should have template formic/default/input" do
+      @input.template.should == 'formic/default/input'
+    end
+
+    it "should have type file" do
+      @input.options[:type].should == 'checkbox'
+    end
+
+    it "should set field value" do
+      @input.field.should == 'name'
+    end
+  end
+end

data/spec/formic/file_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Formic::File do
+  before(:each) do
+    @model = Object.new
+    stub(@page = Object.new).url_for(@model) {'/models/1'}
+    stub(@page).render
+
+    @options = {}
+    @block = Proc.new {}
+  end
+
+  context "#file" do
+    before(:each) do
+      @input = Formic::File.new @page, 'name', @options, &@block
+    end
+
+    it "should have template formic/default/input" do
+      @input.template.should == 'formic/default/input'
+    end
+
+    it "should have type file" do
+      @input.options[:type].should == 'file'
+    end
+
+    it "should set field value" do
+      @input.field.should == 'name'
+    end
+  end
+end