activeadmin_draggable 0.0.5 → 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTM3NGE3NDg0N2YwNjM3OWEzNjliNTJkYWE1MjA3YTI3MjM2NTIzMg==
+  data.tar.gz: !binary |-
+    NDJkNjI4MDZiMzUzYWFmMjhkYmNlMmY2NGY3YjdjNDg1NmJkMjdlNw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NWVmMTkzNGM4Mzk5ODQ1ZTU1ZWE4NDZhZjI4YTg4NjJiY2JhZWQ1OGY1ZTJj
+    NzQ1MmE5ZGFhMjM0Nzg2YjEyNmI2MmRmY2U3ZjEzZDkwNTJiY2QxNjE5N2Y0
+    NTFiMmZkOTE1ZGNmNzU1YjNjNTllMGJhNTFhOTQ2MDY0MDA0Zjg=
+  data.tar.gz: !binary |-
+    YjE0N2JlNjc4OTIzMjU2ODliNDdiOWY1NzIzZDcyNTgwZTQ4NWIwMGRkNTE4
+    ZWI1MzFhMTQzZmU2ZGUxYjJmNTRhNjExOTljZmIwNmJmNmZiZjg5ZDk1MDUw
+    ZTIxMTM3ZjQ2Yzk4NTE2MzQzYjBlYmQ5MWY4NjJkNmFmNTg4NGI=

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+.rvmrc
 .bundle
 .config
 .yardoc

data/README.rdoc

@@ -0,0 +1,122 @@
+= ActiveadminDraggable
+
+ActiveadminDraggable is a items reordering add on to active_admin tables.
+With build in javascript and methods allows you to easily change your item index tables
+in active_admin into sortable tables. With one click you will be able to enter +reorder+ mode
+and drag and drop items to desired position in the list. Asynchronous javascript will update their
+position for you.
+
+Functionality was initialy created by @detomastah for one of our projects. 
+
+== Installation
+
+* Install activeadmin_draggable
+
+  Add this line to your application's Gemfile:
+
+      gem 'activeadmin_draggable'
+
+  And then execute:
+
+      $ bundle
+
+  Or install it yourself as:
+
+      $ gem install activeadmin_draggable
+
+  Add to your application.js
+    
+      //= require activeadmin_draggable
+
+* Install acts_as_list 
+
+  acts_as_list adds lists functionality to your models basing on position column. 
+
+  Basic setup required for this gem to work is:
+
+  Add this line to your application's Gemfile:
+
+      gem 'acts_as_list'
+
+  And then execute:
+
+      $ bundle
+
+  Or install it yourself as:
+
+      $ gem install acts_as_list
+
+== Usage
+  
+* the +list+ functionality
+
+  First you need to add +acts_as_list+ to resource you want to make sortable in active_admin.
+
+  You can find details docs at: https://github.com/swanandp/acts_as_list but for our purpouses you just need to:
+
+    rails g migration AddPositionToResourceName position:integer
+    rake db:migrate
+
+  After that you can use acts_as_list method in the model:
+
+    class SomeClass < ActiveRecord::Base
+      acts_as_list
+    end
+ 
+* adding +sortable_table+ in active_admin resource
+
+  Suppose we want to make Post resource sortable
+
+  Require +'activeadmin_draggable'+ on the top of your file.
+
+  Add index action using newly added +:sortable_table+ view
+ 
+    ActiveAdmin.register Post do
+      config.sort_order = "position_asc"
+
+      index :as => :sortable_table do
+        config.sort_order = "posts.position ASC"
+
+        column :name
+        column :position
+     
+      end
+    
+      ...
+
+    end
+
+  Add reorder action which is used to change position after droping item. 
+  First argument to +ActiveadminDraggable::DraggableListItem.move" method is class name of resource
+    
+      ...
+
+      collection_action :reorder, :method => :put do
+        ActiveadminDraggable::DraggableListItem.move(Post, params[:id], params[:left_id])
+
+        head(:ok)
+      end 
+
+      ...
+
+  Add +reorder+ button to index page
+  
+      ...
+
+      action_item :only => :index do
+        link_to 'Reorder mode', reorder_admin_posts_path, :class => "reorder", "data-on_text" => "Reorder mode", "data-off_text" => "Reorder mode off"
+      end 
+
+      ...
+
+  Texts can be of course changed. 
+    * data-off_text for disabling reorder mode
+    * data-on_text for enabling reorder mode 
+
+== Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1 +1,38 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveadminDraggable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/activeadmin_draggable.gemspec

@@ -18,6 +18,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "rails", "~> 3.2.0"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "activeadmin"
+  spec.add_development_dependency "sass-rails"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "capybara"
+  spec.add_development_dependency "acts_as_list"
 end

data/lib/activeadmin_draggable.rb

@@ -1,4 +1,4 @@
-require "activeadmin_draggable/version"
+require 'activeadmin_draggable/version'
 require 'activeadmin_draggable/engine'
 require 'activeadmin_draggable/draggable_list_item'
 require 'activeadmin_draggable/sortable_tree'

data/lib/activeadmin_draggable/engine.rb

@@ -1,4 +1,7 @@
 module ActiveadminDraggable
-  class Engine < Rails::Engine
+  class Engine < ::Rails::Engine
+    initializer 'activeadmin_draggable.load_static_assests' do |app|
+      app.middleware.use ::ActionDispatch::Static, "#{root}/vendor"
+    end
   end
 end

data/lib/activeadmin_draggable/sortable_tree.rb

@@ -1,3 +1,5 @@
+require 'activeadmin'
+
 module ActiveAdmin
   module Views
     # An index page component, which allows both list and tree reordering

data/lib/activeadmin_draggable/version.rb

@@ -1,3 +1,3 @@
 module ActiveadminDraggable
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.