rails_admin_slug 0.1.0 → 0.1.1

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+rails_admin_slug-*

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -0,0 +1,52 @@
+# RailsAdminSlug
+
+A RailsAdmin field type to create a URL slug as you type a page title 
+
+## What is it
+
+Normally when using a gem like FriendlyId, the slug is created server side where the end user has no way of editing what the slug may be. Sure you can have a form field where they can fill in the slug if they so desire, or edit the slug after the model is created. This can lead to confusion and disuse with less technical users. 
+
+This gem brings the slug creation to the client side in RailsAdmin. The slug is automatically created when a user types the model title. From there the slug can be reviewed and edited before initial model creation. 
+
+## Installing
+
+Simply add the gem to your projects Gemfile after the rails_admin line.
+
+    gem "rails_admin_slug"
+
+Create a rails_admin/custom/ui.js file and add the following line to the top (or just add if the file already exists):
+
+    //=require 'ra.slug'
+
+## Usage
+
+In your RailsAdmin configuration file (usually config/initializers/rails_admin.rb) override the field type for the slug field.
+The "source" configuration option defines which field the slug will be tied to and is required to be set.
+
+    RailsAdmin.config do |config|
+      config.model 'Page' do
+        edit do
+          field :slug, :slug do
+            source 'title'
+          end
+        end
+      end
+    end
+
+The slug field type extends the string field type. This means it is still possible to set other configuration items.
+
+    RailsAdmin.config do |config|
+      config.model 'Page' do
+        edit do
+          field :slug, :slug do
+            source 'title'
+            help 'You may edit the slug if you wish'
+          end
+        end
+      end
+    end
+
+## Credits
+
+The jquery plugin that creates and edit the client side slug is from Patrick McElhaney and can be found at: https://github.com/pmcelhaney/jQuery-Slugify-Plugin/blob/master/readme.md
+

data/lib/rails_admin_slug.rb

@@ -1,2 +1,2 @@
-require 'rails_admin_slug/engine.rb'
-require 'rails_admin_slug/slug.rb'
+require 'rails_admin_slug/engine'
+require 'rails_admin_slug/slug'

data/lib/rails_admin_slug/engine.rb

@@ -0,0 +1,6 @@
+module RailsAdminSlug
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/rails_admin_slug/slug.rb

@@ -0,0 +1,28 @@
+require 'rails_admin/config/fields/base'
+require 'rails_admin/config/fields/types/string'
+
+
+module RailsAdmin
+  module Config
+    module Fields
+      module Types
+        class Slug < RailsAdmin::Config::Fields::Types::String
+
+          RailsAdmin::Config::Fields::Types::register(self)
+
+          register_instance_option :source do
+            @source ||= properties && properties[:source]
+          end
+
+          register_instance_option :html_attributes do
+            {
+              :maxlength => length,
+              :size => [50, length.to_i].min,
+              :'data-slug' =>  "#{self.abstract_model.model.name.underscore}_#{source}"
+            }
+           end
+        end
+      end
+    end
+  end
+end

data/rails_admin_slug.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name        = 'rails_admin_slug'
+  s.version     = '0.1.1'
+  s.date        = '2013-04-23'
+  s.summary     = "RailsAdmin Slug"
+  s.description = "A RailsAdmin field type to create a URL slug as you type a page title "
+  s.authors     = ["Tim Watson"]
+  s.email       = ['tiwatson@gmail.com']
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'http://tiwatson.com'
+  s.require_path = 'lib'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_admin_slug
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -18,8 +18,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/rails_admin_slug.rb
+- .gitignore
+- Gemfile
+- README.md
 - app/assets/javascripts/ra.slug.js
+- lib/rails_admin_slug.rb
+- lib/rails_admin_slug/engine.rb
+- lib/rails_admin_slug/slug.rb
+- rails_admin_slug.gemspec
 - vendor/assets/javascripts/jquery.slugify.js
 homepage: http://tiwatson.com
 licenses: []