linkify 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in linkify.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Henk Meijer, Eskes Media
+
+MIT License
+
+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/README.md

@@ -0,0 +1,73 @@
+# Linkify
+
+Linkify makes it possible to list all records from specific models in a grouped_options_for_select array. This can by very useful for internal linking. It doesn't return absolute or relative paths by default, but instead gives you the model name and identifier (usually ID) of a record, so you have'll to create your own logic for generating links from this information afterwards.
+
+This gem integrates easily with any Rails app using ActiveRecord.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'Linkify'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install Linkify
+
+## Example output
+    <select>
+      <optgroup label="Artikel">
+        <option value="["Article", 207]">Voluptatem In Sit Ut Fugit Totam Suscipit</option>
+        <option value="["Article", 208]">Minima Id Laboriosam Itaque Minus</option>
+        <option value="["Article", 209]">Aut Et Est</option>
+        <option value="["Article", 210]">Sunt Commodi Itaque</option>
+      </optgroup>
+    </select>
+## Usage
+
+Want to add a 'link to page' drop down in a form, simply call the `internal_links` method for the options_for_select parameter.
+
+Example:
+
+    <%= form_for @link do |f| %>
+      <%= f.select :url_options, internal_links %>
+      ...
+      <%= f.submit %>
+    <% end %>
+
+## Add models to the list
+
+By default, no records will return if you call this method. For each model you want to list, you have to add this method to the model:
+
+    linkable_by :title, :id
+    
+It takes two parameters:
+
+1. the name you'll see in the `<option>`
+2. the value that will be in the `<option>`
+3. the find method to select records from this model (defaults to `all` but could also be a (named) scope or custom method)
+  
+## Add extra pages (static pages for example)
+Sometimes you want to not only list records from the database, but also static pages: home, contact, about, etc. To add these to the `<select>` too, you can pass them as a parameter to the `internal_links` method:
+  
+    <%= select_tag "url", internal_links([["contact", "/contact"], ["about", "/about"]]) %>
+    
+I don't like to link to URL's directly but prefer to link to a Rails helper method instead. For example:
+    
+    # in the form
+    <%= select_tag "path", internal_links([["contact", "contact_path"], ["about", "about_path"]]) %>
+    
+    # in the place I need to show this link
+    <%= link_to @link.name, send(@link.path)%>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/linkify.rb

@@ -0,0 +1,18 @@
+require "linkify/version"
+require "linkify/models/active_record" if defined?(::ActiveRecord)
+require 'linkify/view_helper'
+module Linkify
+  module Rails
+    class Engine < ::Rails::Engine
+      
+    end
+  end
+end
+
+
+ActionView::Base.send :include, Linkify::ViewHelper
+
+if defined?(Rails)
+  require "linkify/railtie"
+  Linkify::Railtie.insert
+end

data/lib/linkify/models/active_record.rb

@@ -0,0 +1,27 @@
+require 'linkify/models/base'
+
+module Linkify
+  module Model
+    module ActiveRecord
+      include Base
+
+      ##
+      # Set attribute names and include the Linky module.
+      #
+      def linkable_by(title, path, finder_method=:all, options = {}, &block)
+        linkable_init(
+          :linkable     => true,
+          :user_title   => title,
+          :user_path    => path,
+          :finder_method => finder_method
+        )
+      end
+
+
+      private # --------------------------------------------------------------
+
+      def geocoder_file_name;   "active_record"; end
+      def geocoder_module_name; "ActiveRecord"; end
+    end
+  end
+end

data/lib/linkify/models/base.rb

@@ -0,0 +1,58 @@
+require 'linkify'
+
+module Linkify
+
+  ##
+  # Methods for invoking Linky in a model.
+  #
+  module Model
+    module Base
+      def linky_options
+        if defined?(@linky_options)
+          @linky_options
+        elsif superclass.respond_to?(:linky_options)
+          superclass.linky_options || { }
+        else
+          { }
+        end
+      end
+
+      def linkable_by
+        fail
+      end
+
+      def linkable
+        linky_options[:linkable]
+      end
+      
+      def linkable_title
+        linky_options[:user_title]
+      end
+      
+      def linkable_path
+        linky_options[:user_path]
+      end
+      
+      def linkable_method
+        linky_options[:finder_method]
+      end
+      
+      def linkable_records
+        if linkable_method == :all
+          all
+        else
+          linkable_method
+        end
+      end
+      
+    private
+
+      def linkable_init(options)
+        unless @linky_options
+          @linky_options = {}
+        end
+        @linky_options.merge! options
+      end
+    end
+  end
+end

data/lib/linkify/railtie.rb

@@ -0,0 +1,23 @@
+require 'linkify'
+require 'linkify/models/active_record'
+
+module Linkify
+  if defined? Rails::Railtie
+    require 'rails'
+    class Railtie < Rails::Railtie
+      initializer 'railtie.insert_into_active_record' do
+        ActiveSupport.on_load :active_record do
+          Linkify::Railtie.insert
+        end
+      end
+    end
+  end
+
+  class Railtie
+    def self.insert
+      if defined?(::ActiveRecord)
+        ::ActiveRecord::Base.extend(Model::ActiveRecord)
+      end
+    end
+  end
+end

data/lib/linkify/version.rb

@@ -0,0 +1,3 @@
+module Linkify
+  VERSION = "0.0.1"
+end

data/lib/linkify/view_helper.rb

@@ -0,0 +1,45 @@
+module Linkify
+  # Contains methods to use in views and helpers.
+  
+  module ViewHelper
+    
+    
+    # renders a select
+    def internal_links(additional_pages=[])
+      grouped_options_for_select(grouped_options(additional_pages))
+    end
+    
+    def all_models
+      list = []
+      Dir.foreach("#{::Rails.root}/app/models") do |model_path|
+        # only take .rb files
+        if model_path[-2,2] == "rb"
+          mod = model_path.gsub('.rb', '').camelize.constantize 
+          list << mod if mod.linkable
+        end
+      end
+      return list
+    end
+    
+    def grouped_options(additional_pages)
+      options = []
+      # add additional pages to the list first
+      pages  =[]
+      for page in additional_pages
+        pages << page
+      end
+      options << ["-", pages] if pages.any?
+      # then, add records from the database
+      for mod in all_models
+        model_array = []
+        mod.linkable_records.each do |record|
+          model_array << [record.send(mod.linkable_title), [mod.to_s, record.send(mod.linkable_path)]]
+        end
+        options << [I18n.t("activerecord.models.#{mod.to_s.underscore}"), model_array]
+      end
+      return options
+    end
+    
+   
+  end
+end

data/linkify.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/linkify/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Henk Meijer"]
+  gem.email         = ["meijerhenk@gmail.com"]
+  gem.description   = %q{Lists all the available routes in your rails app, to add internal linking to admin pages}
+  gem.summary       = %q{Linky lists all the possible routes in your Rails app in a drop-down menu}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "linkify"
+  gem.require_paths = ["lib"]
+  gem.version       = Linkify::VERSION
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: linkify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Henk Meijer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-12 00:00:00.000000000 Z
+dependencies: []
+description: Lists all the available routes in your rails app, to add internal linking
+  to admin pages
+email:
+- meijerhenk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/linkify.rb
+- lib/linkify/models/active_record.rb
+- lib/linkify/models/base.rb
+- lib/linkify/railtie.rb
+- lib/linkify/version.rb
+- lib/linkify/view_helper.rb
+- linkify.gemspec
+homepage: ''
+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.24
+signing_key: 
+specification_version: 3
+summary: Linky lists all the possible routes in your Rails app in a drop-down menu
+test_files: []
+has_rdoc: