radiant-fabulator_exhibit-extension 0.0.1

data/History.txt

@@ -0,0 +1,5 @@
+=== 0.0.1 2010-08-10
+
+* 1 major enhancement:
+  * Initial release
+

data/README.markdown

@@ -0,0 +1,38 @@
+Fabulator Exhibit Extension
+===========================
+
+This extension acts as the glue tieing together the Fabualtor Radiant extension
+and the Fabulator engine Exhibit extension.
+
+Installation
+------------
+
+Installation is done in the usual manner for Radiant extensions.
+
+This extension requires Radiant 0.9 or higher as well as the following
+libraries:
+
+* ruby-fabulator-exhibit gem
+
+== LICENSE:
+
+Copyright (c) 2009-2010 Texas A&M University
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,139 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "radiant-fabulator_exhibit-extension"
+    gem.summary = %Q{Fabulator Exhibit Extension for Radiant CMS}
+    gem.description = %Q{Provides storage management for the Fabulator Exhibit extension for use with the Radiant CMS.}
+    gem.email = "jgsmith@tamu.edu"
+    gem.homepage = "http://github.com/jgsmith/radiant-fabulator-exhibit"
+    gem.authors = ["James Smith"]
+    gem.add_dependency('radiant-fabulator-extension', '>= 0.0.3')
+    gem.add_dependency('fabulator-exhibit', '>= 0.0.1')
+    gem.add_dependency('json', '>= 1.4.3')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. This is only required if you plan to package fabulator_rdf as a gem."
+end
+
+# In rails 1.2, plugins aren't available in the path until they're loaded.
+# Check to see if the rspec plugin is installed first and require
+# it if it is.  If not, use the gem version.
+
+# Determine where the RSpec plugin is by loading the boot
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(RADIANT_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+# Cleanup the RADIANT_ROOT constant so specs will load the environment
+Object.send(:remove_const, :RADIANT_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :features => 'spec:integration'
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  desc "Run the Cucumber features"
+  Cucumber::Rake::Task.new(:integration) do |t|
+    t.fork = true
+    t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'pretty')]
+    # t.feature_pattern = "#{extension_root}/features/**/*.feature"
+    t.profile = "default"
+  end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the fabulator_rdf extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FabulatorRdfExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the fabulator_rdf extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/app/controllers/admin/fabulator/exhibits_controller.rb

@@ -0,0 +1,21 @@
+module Admin
+  module Fabulator
+    class ExhibitsController < Admin::ResourceController
+      only_allow_access_to :index, :show, :new, :create, :edit, :update, :remove, :destroy,
+        :when => [:designer, :admin],
+        :denied_url => { :controller => 'admin/pages', :action => 'index' },
+        :denied_message => 'You must have designer privileges to perform this action.'
+
+      def model_class
+        FabulatorExhibit
+      end
+
+      def show
+        respond_to do |format|
+          format.xml { super }
+          format.html { redirect_to edit_admin_fabulator_exhibits_path(params[:id]) }
+        end
+      end
+    end
+  end
+end

data/app/controllers/api/exhibits_controller.rb

@@ -0,0 +1,12 @@
+class Api::ExhibitsController < ApplicationController
+  skip_before_filter :verify_authenticity_token
+
+  no_login_required
+
+  def show
+    @exhibit = FabulatorExhibit.find(:first, :conditions => [ "name = ?", params[:id] ])
+    respond_to do |format|
+      format.json { render :json => @exhibit.data }
+    end
+  end
+end

data/app/models/fabulator_exhibit.rb

@@ -0,0 +1,7 @@
+class FabulatorExhibit < ActiveRecord::Base
+  validates_presence_of :name
+  validates_uniqueness_of :name
+
+  belongs_to :updated_by, :class_name => 'User'
+  belongs_to :created_by, :class_name => 'User'
+end

data/app/views/admin/fabulator/exhibits/_form.html.haml

@@ -0,0 +1,28 @@
+- form_for [:admin, @fabulator_exhibit], :html => {:onsubmit_status => onsubmit_status(@fabulator_exhibit)} do |f|
+  = f.hidden_field :lock_version
+  = render_region :form_top
+  .form_area
+    - render_region :form do |form|
+      - form.edit_title do
+        %p.title
+          = f.label :name
+          = f.text_field :name, :class => 'textbox activate', :maxlength => 100
+      - form.edit_description do
+        %p.content
+          = f.label :description, "Description"
+          ~ f.text_area :description, :class => "textarea large", :style => "width: 100%"
+      .row
+      - form.edit_fn do
+        %p.content
+          = f.label :description, "Description"
+          = f.text_area :description, :class => "textarea large", :style => "width: 100%"
+  - render_region :form_bottom do |form_bottom|
+    - form_bottom.edit_buttons do
+      %p.buttons{:style=>"clear: left"}
+        = save_model_button(@fabulator_workflow_def, :label => 'Create Exhibit Database')
+        = save_model_and_continue_editing_button(@fabulator_exhibit)
+        or
+        = link_to 'Cancel', admin_fabulator_exhibits_url
+    - form_bottom.edit_timestamp do
+      %p.updated_line
+        = updated_stamp @fabulator_exhibit

data/app/views/admin/fabulator/exhibits/edit.html.haml

@@ -0,0 +1,9 @@
+- @page_title = @fabulator_exhibit.name + ' Exhibit Database - ' + default_page_title
+
+- body_classes << "reversed"
+
+- render_region :main do |main|
+  - main.edit_header do
+    %h1 Edit Exhibit Database Definition
+  - main.edit_form do
+    = render :partial => 'form'

data/app/views/admin/fabulator/exhibits/index.html.haml

@@ -0,0 +1,38 @@
+- @page_title = 'Exhibit Databases - ' + default_page_title
+
+.outset
+  - render_region :top
+  %table#exhibits.index
+    %thead
+      %tr
+        - render_region :thead do |thead|
+          - thead.title_header do
+            %th.filter Exhibit Database
+          - thead.size_header do
+            %th.size Items
+          - thead.modify_header do
+            %th.modify Modify
+    %tbody
+      - if @fabulator_exhibits.any?
+        - @fabulator_exhibits.each do |exhibit|
+          %tr.node.level_1
+            - render_region :tbody do |tbody|
+              - tbody.title_cell do
+                %td.snippet
+                  = image('snippet', :alt => '')
+                  %span= link_to exhibit.name, edit_admin_fabulator_exhibit_url(exhibit)
+              - tbody.size_cell do
+                %td.size
+                  %span= exhibit.items_count
+              - tbody.modify_cell do
+                %td.remove
+                  = link_to image('remove', :alt => 'Remove Exhibit Database'), remove_admin_fabulator_exhibit_url(exhibit)
+      - else
+        %tr
+          %td.note{:colspan => admin.fabulator_exhibit.index.tbody.length} No Exhibit Databases
+
+- render_region :bottom do |bottom|
+  - bottom.new_button do
+    #actions
+      %ul
+        %li= link_to "New Exhibit Database", { :controller => 'admin/fabulator/exhibits', :action => 'new' }

data/app/views/admin/fabulator/exhibits/new.html.haml

@@ -0,0 +1,7 @@
+- body_classes << "reversed"
+
+- render_region :main do |main|
+  - main.edit_header do
+    %h1 New Exhibit Database
+  - main.edit_form do
+    = render :partial => 'form'

data/app/views/admin/fabulator/exhibits/remove.html.haml

@@ -0,0 +1,19 @@
+%h1 Remove Exhibit Database
+
+%p 
+  Are you sure you want to 
+  %strong.warning permanently remove
+  the following exhibit database?
+
+%table.index#workflows
+  %tbody
+    %tr.node.level_1
+      %td.workflow
+        = image('snippet', :alt => "")
+        %span.title= @fabulator_exhibit.name
+
+- form_for [:admin, @fabulator_exhibit], :html => {:method => :delete, :onsubmit_status=>"Removing exhibit database…"} do
+  %p.buttons
+    %input.button{:type=>"submit", :value=>"Delete Exhibit Database"}/
+    or
+    = link_to 'Cancel', admin_fabulator_exhibits_url

data/config/routes.rb

@@ -0,0 +1,10 @@
+ActionController::Routing::Routes.draw do |map|
+  map.namespace 'admin' do |admin|
+    admin.namespace 'fabulator', :member => { :remove => :get } do |fab|
+      fab.resources :exhibits
+    end
+  end
+  map.namespace 'api' do |api|
+    api.resources :exhibits
+  end
+end

data/db/migrate/001_create_fabulator_exhibit_tables.rb

@@ -0,0 +1,19 @@
+class CreateFabulatorExhibitTables < ActiveRecord::Migration
+  def self.up
+    create_table :fabulator_exhibits do |t|
+      t.string :name, :null => false
+      t.text   :description
+      t.integer :lock_version, :default => 0
+      t.integer :items_count, :default => 0
+      t.text   :data
+      t.references :updated_by
+      t.references :created_by
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :fabulator_exhibits
+  end
+end
+

data/fabulator_exhibit_extension.rb

@@ -0,0 +1,78 @@
+require 'fabulator/exhibit'
+require 'json'
+
+class FabulatorExhibitExtension < Radiant::Extension
+  version "1.0"
+  description "Exhibit extension to the Fabulator extension"
+  url "http://github.com/jgsmith/radiant-fabulator-exhibit"
+
+  class MissingRequirement < StandardError; end
+
+  extension_config do |config|
+    config.gem 'radiant-fabulator-extension'
+    config.gem 'fabulator-exhibit'
+  end
+
+  def activate
+    #raise FabulatorExhibitExtension::MissingRequirement.new('FabulatorExtension must be installed and loaded first.') unless defined?(FabulatorExtension)
+
+    tab 'Fabulator' do
+      add_item("Exhibit Databases", "/admin/fabulator/exhibits")
+    end
+
+    Radiant::AdminUI.class_eval do
+      attr_accessor :exhibits
+      alias_method :fabulator_exhibit, :exhibits
+    end
+    admin.exhibits = load_default_fabulator_exhibit_regions
+
+    Fabulator::Exhibit::Actions::Lib.class_eval do
+      def self.fetch_database(nom)
+        db = FabulatorExhibit.find(:first, :conditions => [ 'name = ?', nom ])
+        if db.nil?
+          return { :items => [], :types => {}, :properties => {} }
+        else
+          data = (JSON.parse(db.data) rescue { 'items' => [], 'types' => {}, 'properties' => {} })
+          ret = { :items => { }, :types => data['types'], :properties => data['properties'] }
+          ret[:properties] = { } if ret[:properties].nil?
+          ret[:types] = { } if ret[:types].nil?
+          data['items'].each do |i| 
+            ret[:items][i['id']] = i
+          end
+          return ret
+        end
+      end
+
+      def self.store_database(nom, data)
+        db = FabulatorExhibit.find(:first, :conditions => [ 'name = ?', nom ])
+        if db.nil?
+          raise "The Exhibit database #{nom} does not exist."
+        end
+        to_save = { :items => data[:items].values, :properties => data[:properties], :types => data[:types] }
+        db.data = to_save.to_json
+        db.items_count = to_save[:items].size
+        db.save
+      end
+    end
+  end
+
+  def deactivate
+  end
+
+  def load_default_fabulator_exhibit_regions
+    returning OpenStruct.new do |exhibit|
+      exhibit.edit = Radiant::AdminUI::RegionSet.new do |edit|
+        edit.main.concat %w{edit_header edit_form}
+        edit.form.concat %w{edit_title edit_description}
+        edit.form_bottom.concat %w{edit_buttons edit_timestamp}
+      end
+      exhibit.index = Radiant::AdminUI::RegionSet.new do |index|
+        index.top.concat %w{help_text}   
+        index.thead.concat %w{title_header size_header modify_header}
+        index.tbody.concat %w{title_cell size_cell modify_cell}
+        index.bottom.concat %w{new_button}
+      end
+      exhibit.new = exhibit.edit
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-fabulator_exhibit-extension
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- James Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-08 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: radiant-fabulator-extension
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fabulator-exhibit
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :runtime
+  version_requirements: *id002
+description: Provides storage management for the Fabulator Exhibit extension for use with the Radiant CMS.
+email: jgsmith@tamu.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- History.txt
+- README.markdown
+- Rakefile
+- VERSION
+- app/controllers/admin/fabulator/exhibits_controller.rb
+- app/controllers/api/exhibits_controller.rb
+- app/models/fabulator_exhibit.rb
+- app/views/admin/fabulator/exhibits/_form.html.haml
+- app/views/admin/fabulator/exhibits/edit.html.haml
+- app/views/admin/fabulator/exhibits/index.html.haml
+- app/views/admin/fabulator/exhibits/new.html.haml
+- app/views/admin/fabulator/exhibits/remove.html.haml
+- config/routes.rb
+- db/migrate/001_create_fabulator_exhibit_tables.rb
+- fabulator_exhibit_extension.rb
+- lib/radiant-fabulator_exhibit-extension.rb
+has_rdoc: true
+homepage: http://github.com/jgsmith/radiant-fabulator-exhibit
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Fabulator Exhibit Extension for Radiant CMS
+test_files: []
+