radiant-file_system_resources-extension 1.1

data/README.textile

@@ -0,0 +1,31 @@
+h1. File System Resources
+
+This enables the use of Radius-based layouts and snippets on the file system. Layouts go in RAILS_ROOT/radiant/layouts, and snippets go in RAILS_ROOT/radiant/snippets.
+
+h2. Quickstart
+
+h3. Install it
+
+h4. Radiant ~1.0
+
+1. add <code>gem 'radiant-file_system_resources-extension'</code>
+   to your Gemfile
+2. Run <code>rake radiant:extensions:update_all</code> to initialise
+   the extension
+3. Run <code>rake radiant:extensions:file_system_resources:migrate</code>
+4. Restart Webserver
+
+h4. Older versions of Radiant (without Gemfile)
+
+1. <code>git submodule add git://github.com/saturnflyer/radiant-file-system-resources-extension.git vendor/extensions/file_system_resources</code>
+2. Migrate it: <code>rake radiant:extensions:file_system_resources:migrate</code>
+3. Restart webserver
+
+h3. Use it
+
+* Create your file-based layouts/snippets
+<pre>RAILS_ROOT/radiant/layouts/your-layout-name.radius
+RAILS_ROOT/radiant/snippets/your-snippet-name.radius</pre>
+* Register your layouts/snippets.  (needed only when add/remove, not on edit)
+<pre>rake radiant:extensions:file_system_resources:register</pre>
+* Your newly created layouts/snippets are now available to use in admin panel.

data/Rakefile

@@ -0,0 +1,120 @@
+# I think this is the one that should be moved to the extension Rakefile template
+
+# 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 'spec/translator'
+
+# 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
+
+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
+  
+  # Hopefully no one has written their extensions in pre-0.9 style
+  # desc "Translate specs from pre-0.9 to 0.9 style"
+  # task :translate do
+  #   translator = ::Spec::Translator.new
+  #   dir = RAILS_ROOT + '/spec'
+  #   translator.translate(dir, dir)
+  # 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 file_system_resources extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FileSystemResourcesExtension'
+  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 file_system_resources 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/app/views/admin/layouts/_edit_form.html.haml

@@ -0,0 +1,17 @@
+- if @layout.new_record? || !@layout.file_system_resource?
+  = defaults[:edit_form]
+- else
+  - if admin?
+    %p File System Resources are not editable in the admin UI. You'll need to edit them on the file system.
+  - else
+    %p This is a standard Layout and is not editable.
+  .form-area
+    %p
+      %strong Layout Location: 
+      = @layout.path
+    %p
+      %strong Content
+    %div{:style => 'overflow: auto;'}
+      %pre
+        =h @layout.content
+  %p= link_to "Return to Layouts", admin_layouts_path

data/app/views/admin/layouts/_layout_type_column.html.haml

@@ -0,0 +1 @@
+%td= layout.file_system_resource? ? 'Standard' : 'Editable'

data/app/views/admin/layouts/_layout_type_head.html.haml

@@ -0,0 +1 @@
+%th.layout Type

data/app/views/admin/snippets/_edit_form.html.haml

@@ -0,0 +1,17 @@
+- if @snippet.new_record? || !@snippet.file_system_resource?
+  = defaults[:edit_form]
+- else
+  - if admin?
+    %p File System Resources are not editable in the admin UI. You'll need to edit them on the file system.
+  - else
+    %p This is a standard Snippet and is not editable.
+  .form-area
+    %p
+      %strong Snippet Location: 
+      = @snippet.path
+    %p
+      %strong Content
+    %div{:style => 'overflow: auto;'}
+      %pre
+        =h @snippet.content
+  %p= link_to "Return to Snippets", admin_snippets_path

data/app/views/admin/snippets/_snippet_type_column.html.haml

@@ -0,0 +1 @@
+%td= snippet.file_system_resource? ? 'Standard' : 'Editable'

data/app/views/admin/snippets/_snippet_type_head.html.haml

@@ -0,0 +1 @@
+%th.layout Type

data/db/migrate/20090824193729_add_file_system_resources.rb

@@ -0,0 +1,11 @@
+class AddFileSystemResources < ActiveRecord::Migration
+  def self.up
+    add_column :layouts, :file_system_resource, :boolean
+    add_column :snippets, :file_system_resource, :boolean
+  end
+
+  def self.down
+    remove_column :layouts, :file_system_resource
+    remove_column :snippets, :file_system_resource
+  end
+end

data/file_system_resources_extension.rb

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require 'radiant-file_system_resources-extension'
+
+class FileSystemResourcesExtension < Radiant::Extension
+  version RadiantFileSystemResourcesExtension::VERSION
+  description RadiantFileSystemResourcesExtension::DESCRIPTION
+  url RadiantFileSystemResourcesExtension::URL
+  
+  def activate
+    Layout.send(:include, FileSystemResource)
+    Snippet.send(:include, FileSystemResource)
+    
+    # Radiant chokes on these files...
+    # admin.layouts.index.add :thead, 'layout_type_head', :before => 'modify_header'
+    # admin.layouts.index.add :tbody, 'layout_type_column', :before => 'modify_cell'
+    # admin.snippets.index.add :thead, 'snippet_type_head', :before => 'modify_header'
+    # admin.snippets.index.add :tbody, 'snippet_type_column', :before => 'modify_cell'
+  end
+end

data/lib/file_system_resource.rb

@@ -0,0 +1,35 @@
+module FileSystemResource
+  def self.included(klass)
+    klass.class_eval do
+      def content
+        if file_system_resource?
+          File.read(path)
+        else
+          self[:content]
+        end
+      end
+      
+      def name
+        file_system_resource? ? self[:name] + '_fs' : self[:name]
+      end
+
+      def path
+        RAILS_ROOT + "/radiant/#{self.class.name.downcase.pluralize}/#{filename}.radius"
+      end
+
+      def content=(value)
+        raise "File System Resources are read-only from the admin." if file_system_resource?
+        self[:content] = value
+      end
+
+      def filename
+        raise "#filename should not be called unless a file_system_resource." unless file_system_resource?
+        self[:content]
+      end
+
+      def filename=(value)
+        self[:content] = value
+      end
+    end
+  end
+end

data/lib/radiant-file_system_resources-extension.rb

@@ -0,0 +1,7 @@
+# -*- encoding: utf-8 -*-
+module RadiantFileSystemResourcesExtension
+  VERSION = '1.1'
+  DESCRIPTION = 'This enables the use of Radius-based layouts and snippets on the file system. Layouts go in RAILS_ROOT/radiant/layouts, and snippets go in RAILS_ROOT/radiant/snippets.'
+  SUMMARY = 'Adds support file system based layouts and snippets.'
+  URL = 'http://terralien.com/'  
+end

data/lib/tasks/file_system_resources_extension_tasks.rake

@@ -0,0 +1,71 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :file_system_resources do
+      
+      desc "Runs the migration of the Fs Resources extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          FileSystemResourcesExtension.migrator.migrate(ENV["VERSION"].to_i)
+        else
+          p FileSystemResourcesExtension.migrations_path
+          FileSystemResourcesExtension.migrator.migrate
+        end
+      end
+
+      namespace :migrate do
+        task :rollback => :environment do
+          step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+          FileSystemResourcesExtension.migrator.rollback(FileSystemResourcesExtension.migrations_path, step)
+        end
+      end
+
+      desc "Copies public assets of the Fs Resources to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        puts "Copying assets from FileSystemResourcesExtension"
+        Dir[FileSystemResourcesExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(FileSystemResourcesExtension.root, '')
+          directory = File.dirname(path)
+          mkdir_p RAILS_ROOT + directory, :verbose => false
+          cp file, RAILS_ROOT + path, :verbose => false
+        end
+        unless FileSystemResourcesExtension.root.starts_with? RAILS_ROOT # don't need to copy vendored tasks
+          puts "Copying rake tasks from FileSystemResourcesExtension"
+          local_tasks_path = File.join(RAILS_ROOT, %w(lib tasks))
+          mkdir_p local_tasks_path, :verbose => false
+          Dir[File.join FileSystemResourcesExtension.root, %w(lib tasks *.rake)].each do |file|
+            cp file, local_tasks_path, :verbose => false
+          end
+        end
+        %w(layouts snippets).each do |dir|
+          FileUtils.mkdir_p(RAILS_ROOT + "/radiant/#{dir}")
+        end
+      end
+      
+      desc "Registers file system resources in the database (needed only when added/removed, not on edit)."
+      task :register => :environment do
+        [Layout, Snippet].each do |klass|
+          seen = []
+          fs_name = klass.name.downcase.pluralize
+          Dir[RAILS_ROOT + "/radiant/#{fs_name}/*.radius"].each do |f|
+            filename = File.basename(f, ".radius")
+            seen << filename
+            if klass.find_by_file_system_resource_and_content(true, filename)
+              puts "Skipped #{klass.name} #{filename} (already registered)."
+              next
+            else
+              name = "#{filename}"
+              klass.create!(:name => name, :filename => filename, :file_system_resource => true)
+              puts "Registered #{klass.name} #{filename}."
+            end
+          end          
+          klass.find_all_by_file_system_resource(true).reject{|e| seen.include?(e.filename)}.each do |e|
+            e.destroy
+            puts "Removed #{klass.name} #{e.filename} (no longer exists on file system)."
+          end
+        end
+      end
+    end
+  end
+end

data/radiant-file_system_resources-extension.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'radiant-file_system_resources-extension'
+
+Gem::Specification.new do |s|
+  s.name        = "radiant-file_system_resources-extension"
+  s.version     = RadiantFileSystemResourcesExtension::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Nathaniel Talbott', 'Jim Gay', 'John Muhl']
+  s.email       = 'nathaniel@talbott.ws'
+  s.homepage    = RadiantFileSystemResourcesExtension::URL
+  s.summary     = RadiantFileSystemResourcesExtension::SUMMARY
+  s.description = RadiantFileSystemResourcesExtension::DESCRIPTION
+
+  ignores = if File.exist?('.gitignore')
+    File.read('.gitignore').split("\n").inject([]) {|a,p| a + Dir[p] }
+  else
+    []
+  end
+
+  s.files         = Dir['**/*'] - ignores
+  s.test_files    = Dir['test/**/*','spec/**/*','features/**/*'] - ignores
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-file_system_resources-extension
+version: !ruby/object:Gem::Version 
+  hash: 13
+  prerelease: 
+  segments: 
+  - 1
+  - 1
+  version: "1.1"
+platform: ruby
+authors: 
+- Nathaniel Talbott
+- Jim Gay
+- John Muhl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-21 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: This enables the use of Radius-based layouts and snippets on the file system. Layouts go in RAILS_ROOT/radiant/layouts, and snippets go in RAILS_ROOT/radiant/snippets.
+email: nathaniel@talbott.ws
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/views/admin/layouts/_edit_form.html.haml
+- app/views/admin/layouts/_layout_type_column.html.haml
+- app/views/admin/layouts/_layout_type_head.html.haml
+- app/views/admin/snippets/_edit_form.html.haml
+- app/views/admin/snippets/_snippet_type_column.html.haml
+- app/views/admin/snippets/_snippet_type_head.html.haml
+- db/migrate/20090824193729_add_file_system_resources.rb
+- file_system_resources_extension.rb
+- lib/file_system_resource.rb
+- lib/radiant-file_system_resources-extension.rb
+- lib/tasks/file_system_resources_extension_tasks.rake
+- radiant-file_system_resources-extension.gemspec
+- Rakefile
+- README.textile
+has_rdoc: true
+homepage: http://terralien.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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.4.2
+signing_key: 
+specification_version: 3
+summary: Adds support file system based layouts and snippets.
+test_files: []
+