radiant-snippets-extension 1.0.2 → 1.1.0.alpha

data/app/controllers/admin/snippet_files_controller.rb

@@ -0,0 +1,3 @@
+class Admin::SnippetFilesController < Admin::ResourceController
+  def show;end
+end

data/app/models/snippet_file.rb

@@ -0,0 +1,49 @@
+class SnippetFile < Struct.new(:name, :content)
+  class << self
+    def find_by_name(name)
+      if file(name)
+        self.new(name, self.read(name))
+      end
+    end
+    alias find find_by_name
+
+    def all
+      Dir.glob([root, '/','*',suffix].join('')).collect{ |file_path|
+        name = File.basename(file_path, suffix)
+        content = File.read(file_path)
+        self.new(name, content)
+      }
+    end
+
+    def root
+      @root ||= Rails.root.to_s + '/app/templates/snippets'
+    end
+
+    def suffix
+      '.radius'
+    end
+
+    def path(name)
+      [root, '/', name, suffix].join('')
+    end
+
+    def file(name, collection=Dir.glob(path(name)))
+      @files ||= {}
+      return @files[name] if @files[name]
+      @files[name] = collection.first
+    end
+
+    def read(name, reader=File)
+      reader.read(file(name))
+    end
+  end
+
+  def to_param
+    name
+  end
+
+  def updated_at
+    time = File.mtime(self.class.file(name))
+    I18n.localize(time, :format => :timestamp)
+  end
+end

data/app/models/snippet_finder.rb

@@ -0,0 +1,24 @@
+class SnippetFinder
+  class << self
+    def find(id)
+      find_map('find',id)
+    end
+
+    def find_by_name(name)
+      find_map('find_by_name', name)
+    end
+
+    def finder_types
+      [SnippetFile, Snippet]
+    end
+
+    private
+
+    def find_map(meth, *args)
+      finder_types.find{|type|
+        found = type.send(meth, *args)
+        return found if found
+      }
+    end
+  end
+end

data/{lib → app/models}/snippet_tags.rb

@@ -36,7 +36,7 @@ module SnippetTags
 
     snippet = @snippet_cache[name]
     unless snippet
-      snippet = Snippet.find_by_name(name)
+      snippet = SnippetFinder.find_by_name(name)
       @snippet_cache[name] = snippet
     end
     snippet

data/app/views/admin/snippet_files/index.html.haml

@@ -0,0 +1,26 @@
+- @page_title = t('snippet_files') + ' - ' + default_page_title
+
+.outset
+  = render_region :top
+  %table.index#snippet_files
+    %thead
+      %tr
+        - render_region :thead do |thead|
+          - thead.title_header do
+            %th.name= t('snippet')
+    %tbody
+      - if @snippet_files.any?
+        - @snippet_files.each do |snippet|
+          %tr[snippet]
+            - render_region :tbody, :locals => {:snippet => snippet} do |tbody|
+              - tbody.title_cell do
+                %td.name
+                  = link_to image('snippet', :alt => '') + ' ' + snippet.name, admin_snippet_file_url(snippet)
+      - else
+        %tr
+          %td.empty{:colspan => admin.snippet.index.tbody.length}= t('no_snippet_files')
+
+- render_region :bottom do |bottom|
+  - bottom.new_button do
+    #actions
+      = pagination_for(@snippet_files)

data/app/views/admin/snippet_files/show.html.haml

@@ -0,0 +1,19 @@
+- @page_title = model.name + ' ' + t('snippet_file') + ' - ' + default_page_title
+
+- render_region :main do |main|
+  - main.header do
+    %h1= model.name
+.form_area
+  - render_region :display_content do |display|
+    - display.title do
+      %p.title
+        = t('name') + ':'
+        = model.name
+    - display.content do
+      %p.content
+        = t('body') 
+        %br/
+        ~ text_area_tag :content, model.content, :class => "textarea large", :style => "width: 95%"
+- render_region :bottom do |bottom|
+  - bottom.timestamp do
+    = model.updated_at

data/config/locales/en.yml

@@ -2,6 +2,8 @@
 en:
   snippet: 'Snippet'   
   snippets: 'Snippets'
+  snippet_files: 'Snippet Files'
+  snippet_file: 'Snippet File'
   config:
     defaults:
       snippet:
@@ -10,6 +12,7 @@ en:
   edit_snippet: 'Edit Snippet'
   new_snippet: 'New Snippet'
   no_snippets: 'No Snippets'
+  no_snippet_files: 'No Snippet Files'
   remove_snippet: 'Remove Snippet'
   text:
     snippets:

data/config/routes.rb

@@ -1,5 +1,6 @@
 ActionController::Routing::Routes.draw do |map|
   map.namespace :admin, :member => { :remove => :get } do |admin|
     admin.resources :snippets
+    admin.resources :snippet_files, :only => [:index, :show]
   end
 end

data/lib/radiant-snippets-extension.rb

@@ -1,5 +1,5 @@
 module RadiantSnippetsExtension
-  VERSION     = "1.0.2"
+  VERSION     = "1.1.0.alpha"
   SUMMARY     = "Snippets for Radiant CMS"
   DESCRIPTION = "Makes Radiant better by adding snippets!"
   URL         = "http://github.com/radiant"

data/snippets_extension.rb

@@ -19,8 +19,10 @@ class SnippetsExtension < Radiant::Extension
     end
     
     Radiant::AdminUI.class_eval do
-      attr_accessor :snippet
+      attr_accessor :snippet, :snippet_file
+
       alias_method :snippets, :snippet
+      alias_method :snippet_files, :snippet_file
 
       def load_default_snippet_regions
         OpenStruct.new.tap do |snippet|
@@ -38,14 +40,32 @@ class SnippetsExtension < Radiant::Extension
           snippet.new = snippet.edit
         end
       end
+
+      def load_default_snippet_file_regions
+        OpenStruct.new.tap do |snippet|
+          snippet.show = Radiant::AdminUI::RegionSet.new do |edit|
+            edit.main.concat %w{ header }
+            edit.display_content.concat %w{ title content }
+            edit.bottom.concat %w{ timestamp }
+          end
+          snippet.index = Radiant::AdminUI::RegionSet.new do |index|
+            index.top.concat %w{}
+            index.thead.concat %w{title_header}
+            index.tbody.concat %w{title_cell}
+            index.bottom.concat %w{new_button}
+          end
+        end
+      end
     end
     
-    admin.snippet ||= Radiant::AdminUI.load_default_snippet_regions
+    admin.snippet       ||= Radiant::AdminUI.load_default_snippet_regions
+    admin.snippet_file  ||= Radiant::AdminUI.load_default_snippet_file_regions
     
-    UserActionObserver.instance.send :add_observer!, Snippet
+    UserActionObserver.instance.send :add_observer!, ::Snippet
                                  
     tab 'Design' do
       add_item "Snippets", "/admin/snippets"
+      add_item "Snippet Files", "/admin/snippet_files"
     end
     
   end

data/spec/fixtures/snippet_template.radius

@@ -0,0 +1 @@
+<h1>Hello</h1>

data/spec/models/snippet_file_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/../snippets_spec_helper.rb')
+
+describe SnippetFile do
+
+  let(:fixture_file){ 
+    spec_directory_path = File.expand_path(File.dirname(__FILE__))
+    fixture_directory_path = spec_directory_path + "/fixtures"
+    Dir.glob(fixture_directory_path + 'snippet_template.radius').first
+  }
+
+  it 'has a root in the Rails path' do
+    SnippetFile.root.should == Rails.root.to_s + '/app/templates/snippets'
+  end
+
+  it 'has a file suffix' do
+    SnippetFile.suffix.should == '.radius'
+  end
+
+  it "returns a snippet file from the found file" do
+    mock_file = OpenStruct.new(:name => 'snippet_template')
+    SnippetFile.stub!(:file).with('snippet_template').and_return(mock_file)
+    SnippetFile.stub!(:read).with('snippet_template').and_return('content')
+    SnippetFile.find_by_name('snippet_template').should be_a(SnippetFile)
+  end
+
+  it 'has a file found by name' do
+    SnippetFile.file(name).should == fixture_file
+  end
+
+  it 'returns contents of a named snippet file' do
+    reader = mock('reader')
+    reader.stub!(:read).and_return('content')
+    SnippetFile.read(name, reader).should == 'content'
+  end
+
+  subject{ SnippetFile.new('test','details')}
+  its(:name){ should == 'test' }
+  its(:content){ should == 'details'}
+end

data/spec/models/snippet_finder_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '/../snippets_spec_helper.rb')
+
+class TestSnippetFinder; end
+class AlternateSnippetFinder; end
+
+describe 'SnippetFinder' do
+  it 'finds a snippet by name in the first finder type' do
+    SnippetFinder.stub!(:finder_types).and_return([TestSnippetFinder, AlternateSnippetFinder])
+    TestSnippetFinder.should_receive(:find_by_name).and_return(OpenStruct.new(:name => 'test_snippet'))
+    
+    SnippetFinder.find_by_name('test_snippet')
+  end
+  it 'finds a snippet by name in the next finder type after no result from the previous' do
+    SnippetFinder.stub!(:finder_types).and_return([TestSnippetFinder, AlternateSnippetFinder])
+    TestSnippetFinder.stub!(:find_by_name).and_return(nil)
+    AlternateSnippetFinder.should_receive(:find_by_name).and_return(OpenStruct.new(:name => 'alternate_snippet'))
+
+    SnippetFinder.find_by_name('alternate_snippet')
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: radiant-snippets-extension
 version: !ruby/object:Gem::Version
-  version: 1.0.2
-  prerelease: 
+  version: 1.1.0.alpha
+  prerelease: 6
 platform: ruby
 authors:
 - Jim Gay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-01 00:00:00.000000000 Z
+date: 2012-08-27 00:00:00.000000000 Z
 dependencies: []
 description: Makes Radiant better by adding snippets!
 email:
@@ -18,9 +18,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- app/controllers/admin/snippet_files_controller.rb
 - app/controllers/admin/snippets_controller.rb
 - app/helpers/admin/snippets_helper.rb
 - app/models/snippet.rb
+- app/models/snippet_file.rb
+- app/models/snippet_finder.rb
+- app/models/snippet_tags.rb
+- app/views/admin/snippet_files/index.html.haml
+- app/views/admin/snippet_files/show.html.haml
 - app/views/admin/snippets/_form.html.haml
 - app/views/admin/snippets/edit.html.haml
 - app/views/admin/snippets/index.html.haml
@@ -37,7 +43,6 @@ files:
 - features/support/env.rb
 - features/support/paths.rb
 - lib/radiant-snippets-extension.rb
-- lib/snippet_tags.rb
 - lib/tasks/snippets_extension_tasks.rake
 - radiant-snippets-extension.gemspec
 - Rakefile
@@ -47,8 +52,11 @@ files:
 - spec/ci/script
 - spec/controllers/admin/snippets_controller_spec.rb
 - spec/datasets/snippets_dataset.rb
+- spec/fixtures/snippet_template.radius
 - spec/lib/radiant/admin_ui_spec.rb
 - spec/models/page_spec.rb
+- spec/models/snippet_file_spec.rb
+- spec/models/snippet_finder_spec.rb
 - spec/models/snippet_spec.rb
 - spec/models/user_action_observer_spec.rb
 - spec/snippets_spec_helper.rb
@@ -68,9 +76,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11
@@ -82,8 +90,11 @@ test_files:
 - spec/ci/script
 - spec/controllers/admin/snippets_controller_spec.rb
 - spec/datasets/snippets_dataset.rb
+- spec/fixtures/snippet_template.radius
 - spec/lib/radiant/admin_ui_spec.rb
 - spec/models/page_spec.rb
+- spec/models/snippet_file_spec.rb
+- spec/models/snippet_finder_spec.rb
 - spec/models/snippet_spec.rb
 - spec/models/user_action_observer_spec.rb
 - spec/snippets_spec_helper.rb