radiant-linx-extension 1.0.0

data/README.md

@@ -0,0 +1,11 @@
+# Linx
+
+This Radiant CMS extension keeps track of links between different content models.
+Right now, all it does is list all the pages using a certain layout on the edit page for that layout.
+
+It could easily be extended to do the same for assets that have page_attachments in the 'clipped' extension.
+
+Ultimately, it could also keep track of e.g. assets referenced in a page, be it by radius tag or plain '<img />' tags.
+For this it will need to keep a table like 'content_links' that keeps track of all references. It would need to parse all pages initially, and then keep things up to date on every update of a page, snippet or layout.
+
+Created by Benny Degezelle for nzffa.org.nz 

data/Rakefile

@@ -0,0 +1,109 @@
+# 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 'rdoc/task'
+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, :features]
+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 linx extension.'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LinxExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

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

@@ -0,0 +1,11 @@
+- if pages = Page.find_all_by_layout_id(@layout.id)
+  = "#{pluralize(pages.count, 'page is', 'pages are')} using this layout:"
+  %table.index#pages{:summary=>t('page_hierarchy'), :style => "background-color: white"}
+    %tbody
+      - pages.each do |page|
+        %tr
+          %td= link_to("#{image('page', :class => "icon")} #{page.title}", edit_admin_page_url(page), :title => page.path)
+          %td{:style => "color: black"}
+            - layout_inheriting_children = page.children.find_all_by_layout_id(nil)
+            - if layout_inheriting_children.any?
+              = "And #{layout_inheriting_children.count} out of #{page.children.count} child pages."

data/config/initializers/radiant_config.rb

@@ -0,0 +1,3 @@
+Radiant.config do |config|
+  # config.define "setting.name", :default => 'value', :select_from => ['foo', 'bar']
+end

data/config/locales/en.yml

@@ -0,0 +1,3 @@
+---
+en:
+  linx: Linx

data/config/routes.rb

@@ -0,0 +1,5 @@
+ActionController::Routing::Routes.draw do |map|
+  # map.namespace :admin, :member => { :remove => :get } do |admin|
+  #   admin.resources :linx
+  # end
+end

data/cucumber.yml

@@ -0,0 +1 @@
+default: --format progress features --tags ~@proposed,~@in_progress

data/features/support/env.rb

@@ -0,0 +1,11 @@
+# Sets up the Rails environment for Cucumber
+ENV["RAILS_ENV"] = "test"
+# Extension root
+extension_env = File.expand_path(File.dirname(__FILE__) + '/../../../../../config/environment')
+require extension_env+'.rb'
+
+Dir.glob(File.join(RADIANT_ROOT, "features", "**", "*.rb")).each {|step| require step unless step =~ /datasets_loader\.rb$/}
+ 
+Cucumber::Rails::World.class_eval do
+  dataset :linx
+end

data/features/support/paths.rb

@@ -0,0 +1,22 @@
+module NavigationHelpers
+  
+  # Extend the standard PathMatchers with your own paths
+  # to be used in your features.
+  # 
+  # The keys and values here may be used in your standard web steps
+  # Using:
+  #
+  #   When I go to the "linx" admin page
+  # 
+  # would direct the request to the path you provide in the value:
+  # 
+  #   admin_linx_path
+  # 
+  PathMatchers = {} unless defined?(PathMatchers)
+  PathMatchers.merge!({
+    # /linx/i => 'admin_linx_path'
+  })
+  
+end
+
+World(NavigationHelpers)

data/lib/radiant-linx-extension.rb

@@ -0,0 +1,8 @@
+module RadiantLinxExtension
+  VERSION     = "1.0.0"
+  SUMMARY     = "Linx for Radiant CMS"
+  DESCRIPTION = "Remembers references between content models in Radiant CMS."
+  URL         = "https://github.com/jomz/radiant-linx-extension"
+  AUTHORS     = ["Benny Degezelle"]
+  EMAIL       = ["benny@gorilla-webdesign.be"]
+end

data/lib/tasks/linx_extension_tasks.rake

@@ -0,0 +1,47 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :linx do
+      
+      desc "Runs the migration of the Linx extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          LinxExtension.migrator.migrate(ENV["VERSION"].to_i)
+          Rake::Task['db:schema:dump'].invoke
+        else
+          LinxExtension.migrator.migrate
+          Rake::Task['db:schema:dump'].invoke
+        end
+      end
+      
+      desc "Copies public assets of the Linx to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        puts "Copying assets from LinxExtension"
+        Dir[LinxExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(LinxExtension.root, '')
+          directory = File.dirname(path)
+          mkdir_p RAILS_ROOT + directory, :verbose => false
+          cp file, RAILS_ROOT + path, :verbose => false
+        end
+      end  
+      
+      desc "Syncs all available translations for this ext to the English ext master"
+      task :sync => :environment do
+        # The main translation root, basically where English is kept
+        language_root = LinxExtension.root + "/config/locales"
+        words = TranslationSupport.get_translation_keys(language_root)
+        
+        Dir["#{language_root}/*.yml"].each do |filename|
+          next if filename.match('_available_tags')
+          basename = File.basename(filename, '.yml')
+          puts "Syncing #{basename}"
+          (comments, other) = TranslationSupport.read_file(filename, basename)
+          words.each { |k,v| other[k] ||= words[k] }  # Initializing hash variable as empty if it does not exist
+          other.delete_if { |k,v| !words[k] }         # Remove if not defined in en.yml
+          TranslationSupport.write_file(filename, basename, comments, other)
+        end
+      end
+    end
+  end
+end

data/linx_extension.rb

@@ -0,0 +1,25 @@
+# Uncomment this if you reference any of your controllers in activate
+# require_dependency "application_controller"
+require "radiant-linx-extension"
+
+class LinxExtension < Radiant::Extension
+  version     RadiantLinxExtension::VERSION
+  description RadiantLinxExtension::DESCRIPTION
+  url         RadiantLinxExtension::URL
+
+  # See your config/routes.rb file in this extension to define custom routes
+
+  extension_config do |config|
+    # config is the Radiant.configuration object
+  end
+
+  def activate
+    admin.layout.edit.add :form, 'usages', :after => :edit_title
+    Admin::LayoutsController.class_eval do 
+      helper Admin::NodeHelper
+    end
+    # tab 'Content' do
+    #   add_item "Linx", "/admin/linx", :after => "Pages"
+    # end
+  end
+end

data/radiant-linx-extension.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "radiant-linx-extension"
+
+Gem::Specification.new do |s|
+  s.name        = "radiant-linx-extension"
+  s.version     = RadiantLinxExtension::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = RadiantLinxExtension::AUTHORS
+  s.email       = RadiantLinxExtension::EMAIL
+  s.homepage    = RadiantLinxExtension::URL
+  s.summary     = RadiantLinxExtension::SUMMARY
+  s.description = RadiantLinxExtension::DESCRIPTION
+
+  # Define gem dependencies here.
+  # Don't include a dependency on radiant itself: it causes problems when radiant is in vendor/radiant.
+  # s.add_dependency "something", "~> 1.0.0"
+  # s.add_dependency "radiant-some-extension", "~> 1.0.0"
+
+  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.executables   = Dir['bin/*'] - ignores
+  s.require_paths = ["lib"]
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require ENV["RADIANT_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{RADIANT_ROOT}/spec/spec_helper"
+
+Dataset::Resolver.default << (File.dirname(__FILE__) + "/datasets")
+# Include any datasets from loaded extensions
+Radiant::Extension.descendants.each do |extension|
+  if File.directory?(extension.root + "/spec/datasets")
+    Dataset::Resolver.default << (extension.root + "/spec/datasets")
+  end
+end
+
+if File.directory?(File.dirname(__FILE__) + "/matchers")
+  Dir[File.dirname(__FILE__) + "/matchers/*.rb"].each {|file| require file }
+end
+
+Spec::Runner.configure do |config|
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures'
+
+  # You can declare fixtures for each behaviour like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so here, like so ...
+  #
+  #   config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: radiant-linx-extension
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Benny Degezelle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-20 00:00:00.000000000 Z
+dependencies: []
+description: Remembers references between content models in Radiant CMS.
+email:
+- benny@gorilla-webdesign.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/views/admin/layouts/_usages.html.haml
+- config/initializers/radiant_config.rb
+- config/locales/en.yml
+- config/routes.rb
+- cucumber.yml
+- features/support/env.rb
+- features/support/paths.rb
+- lib/radiant-linx-extension.rb
+- lib/tasks/linx_extension_tasks.rake
+- linx_extension.rb
+- radiant-linx-extension.gemspec
+- Rakefile
+- README.md
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: https://github.com/jomz/radiant-linx-extension
+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.23.2
+signing_key: 
+specification_version: 3
+summary: Linx for Radiant CMS
+test_files:
+- spec/spec.opts
+- spec/spec_helper.rb
+- features/support/env.rb
+- features/support/paths.rb
+has_rdoc: