refinerycms-formtastic 1.0

data/app/assets/stylesheets/refinery/formtastic/admin.css.scss

@@ -0,0 +1,59 @@
+.formtastic {
+  .input {
+    .label {
+      float: none;
+      margin: 0 0 0.5em 0;
+
+      abbr {
+        margin-left: 0.3em;
+      }
+    }
+  }
+
+  .inputs {
+    input {
+      width: 400px;
+    }
+
+    input, textarea, select {
+      border: 1px solid #7F9DB9;
+      line-height: 20px;
+      padding: 0.4% 0.5%;
+    }
+
+    input.widest, select.widest, textarea.widest {
+      width: 98%;
+    }
+    select.widest {
+      max-width: 98%;
+    }
+
+    input.larger {
+      font-size: 200%;
+    }
+  }
+
+  .tab-panels {
+    fieldset {
+      border: 1px solid red;
+
+      ol {
+        background-color: #F2F2F2;
+        border: 1px solid #CCCCCC;
+        padding: 5px;
+      }
+    }
+  }
+
+  fieldset {
+    ol {
+      li.wymeditor {
+        width: 100%;
+      }
+    }
+  }
+}
+
+.ui-tabs {
+  margin-bottom: 1em;
+}

data/app/helpers/refinery/formtastic/page_tabs_helper.rb

@@ -0,0 +1,71 @@
+module Refinery
+  module Formtastic
+    module PageTabsHelper
+      def tabbed_fieldsets(form, tabs, i18n_scope = nil)
+        content_tag(:div, :class => 'field') do
+          content_tag(:div, :id => 'page-tabs', :class => 'clearfix ui-tabs ui-widget ui-widget-content ui-corner-all') do
+            tabbed_fieldset_headers(tabs, i18n_scope) +
+            tabbed_fieldset_bodies(form, tabs)
+          end
+        end
+      end
+
+      def tabbed_fieldset_headers(tabs, i18n_scope = nil)
+        content_tag(:ul, :id => 'page_parts') do
+          contents = []
+          tabs.each_with_index do |tab, tab_index|
+            classes = ['ui-state-default']
+            classes << 'ui-state-active' if tab_index == 0
+            contents << content_tag(:li, :class => classes.join(' ')) do
+              link_to tab_name(tab, i18n_scope), "##{tab_id(tab)}"
+            end
+          end
+          contents.join("\n").html_safe
+        end
+      end
+
+      def tabbed_fieldset_bodies(form, tabs)
+        content_tag(:div, :id => 'page_part_editors') do
+          tabs.map do |tab|
+            tabbed_fieldset_body(form, tab)
+          end.join("\n").html_safe
+        end
+      end
+
+      def tabbed_fieldset_body(form, tab)
+        if tab.is_a?(Symbol)
+          editor_only_fieldset_body(form, tab)
+        else
+          partial_fieldset_body(form, tab)
+        end
+      end
+
+      private
+
+        def tab_id(tab)
+          name = tab.is_a?(Symbol) ? tab : tab.name
+        end
+
+        def tab_name(tab, i18n_scope = nil)
+          name = tab_id(tab)
+          t(name.to_s, :scope => i18n_scope, :default => name.to_s.titleize)
+        end
+
+        def editor_only_fieldset_body(form, tab)
+          content_tag(:div, :class => 'page_part', :id => tab.to_s) do
+            form.inputs do
+              form.input tab, :as => :wymeditor
+            end
+          end
+        end
+
+        def partial_fieldset_body(form, tab)
+          content_tag(:div, :class => 'page_part', :id => 'images') do
+            render tab.partial, :f => form
+          end
+        end
+    end
+  end
+end
+
+Refinery::AdminController.send(:helper, 'refinery/formtastic/page_tabs')

data/app/inputs/wymeditor_input.rb

@@ -0,0 +1,5 @@
+class WymeditorInput < Formtastic::Inputs::TextInput
+  def input_html_options
+    super.merge(:class => 'wymeditor widest', :rows => 20)
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  refinery:
+    plugins:
+      formtastics:
+        title: Formtastic

data/config/locales/es.yml

@@ -0,0 +1,5 @@
+en:
+  refinery:
+    plugins:
+      formtastics:
+        title: Formtastic

data/config/locales/fr.yml

@@ -0,0 +1,5 @@
+en:
+  refinery:
+    plugins:
+      formtastics:
+        title: Formtastic

data/config/locales/nb.yml

@@ -0,0 +1,5 @@
+en:
+  refinery:
+    plugins:
+      formtastics:
+        title: Formtastic

data/config/locales/nl.yml

@@ -0,0 +1,5 @@
+en:
+  refinery:
+    plugins:
+      formtastics:
+        title: Formtastic

data/lib/generators/refinery/formtastics_generator.rb

@@ -0,0 +1,19 @@
+module Refinery
+  class FormtasticsGenerator < Rails::Generators::Base
+
+    def rake_db
+      rake("refinery_formtastics:install:migrations")
+    end
+
+    def append_load_seed_data
+      create_file 'db/seeds.rb' unless File.exists?(File.join(destination_root, 'db', 'seeds.rb'))
+      append_file 'db/seeds.rb', :verbose => true do
+        <<-EOH
+
+# Added by Refinery CMS Formtastics extension
+Refinery::Formtastics::Engine.load_seed
+        EOH
+      end
+    end
+  end
+end

data/lib/refinery/formtastic.rb

@@ -0,0 +1,22 @@
+require 'refinerycms-core'
+require 'formtastic'
+
+module Refinery
+  autoload :FormtasticGenerator, 'generators/refinery/formtastic_generator'
+
+  module Formtastics
+    require 'refinery/formtastic/engine'
+
+    class << self
+      attr_writer :root
+
+      def root
+        @root ||= Pathname.new(File.expand_path('../../../', __FILE__))
+      end
+
+      def factory_paths
+        @factory_paths ||= [ root.join('spec', 'factories').to_s ]
+      end
+    end
+  end
+end

data/lib/refinery/formtastic/engine.rb

@@ -0,0 +1,14 @@
+module Refinery
+  module Formtastic
+    class Engine < Rails::Engine
+      isolate_namespace Refinery::Formtastic
+
+      config.after_initialize do
+        Refinery::Core.config.register_stylesheet("formtastic")
+        Refinery::Core.config.register_stylesheet("refinery/formtastic/admin")
+        require 'refinery/formtastic/extensions/page_tab'
+        require 'refinery/formtastic/page_tabs_helper'
+      end
+    end
+  end
+end

data/lib/refinery/formtastic/extensions/page_tab.rb

@@ -0,0 +1,13 @@
+require 'refinery/pages/tab'
+
+module Refinery
+  module Pages
+    class Tab
+      def initialize(options = {})
+        options.each do |key, value|
+          self.send("#{key}=", value)
+        end
+      end
+    end
+  end
+end

data/lib/refinerycms-formtastic.rb

@@ -0,0 +1 @@
+require 'refinery/formtastic'

data/readme.md

@@ -0,0 +1,83 @@
+# Formtastic extension for Refinery CMS.
+
+The purpose of this extension is to allow the use of formtastic within Refinery CMS admin views. The main
+user of this would be other extensions, in which case be sure to add a dependency on this gem to your
+extension.
+
+## Why use this gem?
+
+In general, Refinery CMS attempts to follow a path of the most common rails way, in order to make it accessible
+to as many developers as possible. When building CRUD interfaces, I find that most rails developers tend to use
+a form builder of some sort. Although there are other excellent candidates, Formtastic appears to be the most
+widely used form builder, which is predominantly why it was chosen here.
+
+The reasons for using this over the default Refinery option (of no form builder) are twofold.
+
+Firstly, for brevity. It'll let you replace this:
+
+```erb
+<div class='field'>
+  <%= f.label :latitude -%>
+  <%= f.text_field :latitude  -%>
+</div>
+
+<div class='field'>
+  <%= f.label :longitude -%>
+  <%= f.text_field :longitude  -%>
+</div>
+```
+
+With this:
+
+```erb
+<%= f.inputs :latitude, :longitude %>
+```
+
+This comes with all the usual benefits of removing duplication, such as less chance of getting the markup wrong
+in one specific place.
+
+Secondly, for more object oriented field helpers. I strongly recommend creating custom field type classes for any
+type of custom field input (such as an image picker, map location selector, a number with currency, etc). The
+benefits of using a object oriented structure for this over the more functional programming style of using helpers
+(let alone just wacking it in the view) should be obvious.
+
+## Can my Refinery CMS app have a mix of engines with and without formtastic?
+
+Yes. I've tried to style the formtastic forms to look identical to Refinery defaults.
+
+## To install
+
+Add "refinerycms-formtastic" to your gemfile. There are no generators or migrations to run.
+
+## Input types
+
+I've included an input type class for the Wymeditor textareas
+
+```ruby
+f.input tab, :as => :wymeditor
+```
+
+## Refinery Specific helpers
+
+I've added a helper to replace the huge swathe of markup needed to add the tabbed panels used in most
+refinery extensions (such as Pages, Blog, etc).
+
+```erb
+<%= tabbed_fieldsets f, [
+  :description,
+  :potential_uses,
+  Refinery::Pages::Tab.new(:name => 'images', :partial => '/refinery/admin/pages/tabs/images')
+] %>
+```
+It must be supplied with the form object, and an array of tabs. These tabs can be a symbol, in which case
+they simply display a Wymeditor field of that name, or a Refinery::Pages::Tab object, which basically
+just defines a name and a partial.
+
+## How to build this extension as a gem
+
+    cd vendor/extensions/formtastic
+    gem build refinerycms-formtastic.gemspec
+    gem install refinerycms-formtastic.gem
+
+    # Sign up for a http://rubygems.org/ account and publish the gem
+    gem push refinerycms-formtastic.gem

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: refinerycms-formtastic
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Craig Ambrose
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: refinerycms-core
+  requirement: &70236508182500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *70236508182500
+- !ruby/object:Gem::Dependency
+  name: formtastic
+  requirement: &70236508182020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70236508182020
+- !ruby/object:Gem::Dependency
+  name: refinerycms-testing
+  requirement: &70236508181560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :development
+  prerelease: false
+  version_requirements: *70236508181560
+description: A rails engine which allows the use of Formtastic in the RefineryCMS
+  backend.
+email: craig@craigambrose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/stylesheets/refinery/formtastic/admin.css.scss
+- app/helpers/refinery/formtastic/page_tabs_helper.rb
+- app/inputs/wymeditor_input.rb
+- config/locales/en.yml
+- config/locales/es.yml
+- config/locales/fr.yml
+- config/locales/nb.yml
+- config/locales/nl.yml
+- lib/generators/refinery/formtastics_generator.rb
+- lib/refinery/formtastic/engine.rb
+- lib/refinery/formtastic/extensions/page_tab.rb
+- lib/refinery/formtastic.rb
+- lib/refinerycms-formtastic.rb
+- readme.md
+homepage: http://github.com/craigambrose/refinerycms-formtastic
+licenses: []
+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.17
+signing_key: 
+specification_version: 3
+summary: Use formtastic with Refinery CMS
+test_files: []