Merge pull request #9 from workgena/rails-5-1-compability

Rails 5 1 compability

Author: Fivell

Gemfile

@@ -1,4 +1,19 @@
-source "http://rubygems.org"
-# Specify your gem's dependencies in active_admin_sidebar.gemspec
+source 'https://rubygems.org'
 
+# Specify your gem's dependencies in activeadmin_scoped_collection_actions.gemspec
 gemspec
+
+group :test do
+  gem 'sprockets-rails', '3.2.0'
+  gem 'rails', '5.1.1'
+  gem 'turbolinks'
+  gem 'rspec-rails'
+  gem 'activeadmin', '1.0.0'
+  gem 'sass-rails'
+  gem 'sqlite3'
+  gem 'launchy'
+  gem 'database_cleaner'
+  gem 'capybara'
+  gem 'selenium-webdriver'
+  gem 'poltergeist'
+end

README.md

@@ -1,63 +1,81 @@
-# ActiveAdminSidebar
+# ActiveAdmin Sidebar
 
-Provides ability to manipulate sidebar position with activeadmin (tested with activeadmin ~> 1.0.0.pre)
+Provides ability to manipulate sidebar position for ActiveAdmin (tested with ActiveAdmin ~> 1.0.0)
 
+## Install
 
-Add including of css file 
+```ruby
+gem 'active_admin_sidebar'
+# or latest from GitHub
+gem 'active_admin_sidebar', git: 'https://github.com/activeadmin-plugins/active_admin_sidebar.git'
+```
+
+Add including of CSS file
 
 ```scss
-  @import "active_admin_sidebar"; 
+  @import "active_admin_sidebar";
 ```
 
 to the  
-``` 
-app/assets/stylesheets/active_admin.css.scss 
+```
+app/assets/stylesheets/active_admin.css.scss
 ```
 
 And including of coffee file (optional, need only for collapsed sidebar)
 
-```js
-  //= require active_admin_sidebar
+```coffeescript
+  #= require active_admin_sidebar
 ```
 
 to the  
-``` 
+
+```scss
 app/assets/javascripts/active_admin.js
 ```
 
-Changing sidebar position dynamically with before_filter
+# Configuration per resource
+
+Changing sidebar position dynamically with before_action
+
 ```ruby
   # app/admin/posts.rb
   ActiveAdmin.register Post do
-    before_filter :left_sidebar!, only: [:show]
+    before_action :left_sidebar!, only: [:show]
   end
 
   # app/admin/comments.rb
   ActiveAdmin.register Comment do
-    before_filter :right_sidebar!
+    before_action :right_sidebar!
   end
 ```
 
+## Global configuration
 
-Moving sidebar to the left within all resource (config/initializers/active_admin.rb)
+Moving sidebar to the left within all resource. Set configuration in `config/initializers/active_admin.rb`
 
 ```ruby
-  # == Controller Filters
+  # == Controller before-actions
   #
-  # You can add before, after and around filters to all of your
-  # Active Admin resources from here.
-  #
-  config.before_filter do
-    left_sidebar! if respond_to?(:left_sidebar!)
-  end 
+  # You can add before, after and around actions to all of your resources
+  ActiveAdmin.setup do |config|
+    config.before_action do
+      left_sidebar! if respond_to?(:left_sidebar!)
+    end
+  end
 ```
 
-Also you can use sidebar collapsing. It will add css icon in title of first sidebar will save current state in session
+## Collapsing sidebar
+
+You can use sidebar collapsing.
+It will add "hide/show" button. Shown/Hidden state is persisted across all pages.
+
 ```ruby
   left_sidebar!(collapsed: true)
 ```
-You can override button color according to your color theme:
-```css
+
+You can override button color according to your color theme. For example:
+
+```scss
   body.active_admin {
     #active_admin_content.left_sidebar, #active_admin_content.collapsed_sidebar {
       .collapse_btn, .uncollapse_btn {
@@ -70,8 +88,3 @@ You can override button color according to your color theme:
 Example
 
 ![Alt text](https://raw.githubusercontent.com/activeadmin-plugins/active_admin_sidebar/master/screen/sidebar.jpg "Example")
-
-
-
-
-

Rakefile

@@ -1 +1,7 @@
-require "bundler/gem_tasks"
+require "bundler"
+require 'rake'
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+# Import all our rake tasks
+FileList['tasks/**/*.rake'].each { |task| import task }

lib/active_admin_sidebar/positions.rb

@@ -18,7 +18,7 @@ def right_sidebar!
     def collapsed_sidebar
       if request.xhr?
         if params[:collapsed_sidebar].present?
-          collapsed = ActiveRecord::ConnectionAdapters::Column::TRUE_VALUES.include? params[:collapsed_sidebar]
+          collapsed = params[:collapsed_sidebar].to_s == 'true'
           session[:collapsed_sidebar] = collapsed
           render json: { collapsed_sidebar: collapsed } and return
         end

lib/active_admin_sidebar/version.rb

@@ -1,3 +1,3 @@
 module ActiveAdminSidebar
-  VERSION = "0.1.0.rc3"
+  VERSION = "1.0.0"
 end

spec/sidebars_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe 'authors index', type: :feature, js: true do
+
+  before do
+    Author.create!(name: 'John', last_name: 'Doe')
+    Author.create!(name: 'Jane', last_name: 'Roe')
+    add_author_resource
+    add_post_resource
+  end
+
+  context 'left-sidebar with default settings' do
+    before do
+      visit '/admin/authors'
+    end
+
+    it 'has left-sidebar with colapse-button' do
+      expect(page).to have_css('#filters_sidebar_section')
+      expect(page).to have_css('#filters_sidebar_section .collapse_btn.icono-caret-left')
+      expect(page).to have_css('#active_admin_content.with_sidebar.left_sidebar.collapsible_sidebar')
+    end
+
+    context 'when click on Collapse' do
+      before do
+        page.find('#filters_sidebar_section .collapse_btn').click
+      end
+
+      it "sidebar is hidden, and save it's state after going to another page" do
+        expect(page).to have_css('#sidebar', visible: :hidden)
+
+        # Posts page is configured as: "before_action :skip_sidebar!"
+        visit '/admin/posts'
+        # sidebar does not exists at all
+        expect(page).to have_css('#page_title', text: 'Posts')
+        expect(page).not_to have_css('#sidebar', visible: :all)
+
+        visit '/admin/authors'
+        # sidebar is hidden
+        expect(page).to have_css('#page_title', text: 'Authors')
+        expect(page).to have_css('#sidebar', visible: :hidden)
+
+        page.find('.uncollapse_btn').click
+
+        # sidebar is visible
+        expect(page).to have_css('#sidebar', visible: :visible)
+        expect(page).to have_css('.collapse_btn')
+        expect(page).not_to have_css('.uncollapse_btn')
+      end
+    end
+
+  end
+
+end

spec/spec_helper.rb

@@ -0,0 +1,68 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH << File.expand_path('../support', __FILE__)
+
+ENV['BUNDLE_GEMFILE'] = File.expand_path('../../Gemfile', __FILE__)
+require "bundler"
+Bundler.setup
+
+ENV['RAILS_ENV'] = 'test'
+# Ensure the Active Admin load path is happy
+require 'rails'
+ENV['RAILS'] = Rails.version
+ENV['RAILS_ROOT'] = File.expand_path("../rails/rails-#{ENV['RAILS']}", __FILE__)
+# Create the test app if it doesn't exists
+unless File.exists?(ENV['RAILS_ROOT'])
+  system 'rake setup'
+end
+
+require 'active_model'
+# require ActiveRecord to ensure that Ransack loads correctly
+require 'active_record'
+require 'active_admin'
+ActiveAdmin.application.load_paths = [ENV['RAILS_ROOT'] + "/app/admin"]
+require ENV['RAILS_ROOT'] + '/config/environment.rb'
+# Disabling authentication in specs so that we don't have to worry about
+# it allover the place
+ActiveAdmin.application.authentication_method = false
+ActiveAdmin.application.current_user_method = false
+
+require 'rspec/rails'
+require 'support/admin'
+require 'capybara/rails'
+require 'capybara/rspec'
+require 'capybara/poltergeist'
+
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = false
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.clean_with(:truncation)
+  end
+  config.before(:each) do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.start
+  end
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+end
+
+# RSpec.configure do |config|
+#   config.before(:each, js: true) do
+#     page.driver.browser.manage.window.maximize  if page.driver.browser.respond_to?(:manage)
+#   end
+# end
+# Capybara.javascript_driver = :selenium
+
+Capybara.register_driver :poltergeist do |app|
+  Capybara::Poltergeist::Driver.new(app, {
+    js_errors: true,
+    timeout: 80,
+    debug: true,
+    :phantomjs_options => ['--debug=no', '--load-images=no']
+  })
+end
+Capybara.javascript_driver = :poltergeist

spec/support/admin.rb

@@ -0,0 +1,21 @@
+def add_author_resource(options = {}, &block)
+
+  ActiveAdmin.register Author do
+    config.filters = true
+  end
+
+  Rails.application.reload_routes!
+
+end
+
+
+def add_post_resource(options = {}, &block)
+
+  ActiveAdmin.register Post do
+    config.filters = true
+    before_action :skip_sidebar!
+  end
+
+  Rails.application.reload_routes!
+
+end

spec/support/rails_template.rb

@@ -0,0 +1,43 @@
+# Rails template to build the sample app for specs
+
+generate :model, 'author name:string{10}:uniq last_name:string birthday:date'
+generate :model, 'post title:string:uniq body:text author:references'
+
+#Add validation
+inject_into_file "app/models/author.rb", "  validates_presence_of :name\n  validates_uniqueness_of :last_name\n", after: "Base\n"
+inject_into_file "app/models/post.rb", "   validates_presence_of :author\n", after: ":author\n"
+
+# Configure default_url_options in test environment
+inject_into_file "config/environments/test.rb", "  config.action_mailer.default_url_options = { :host => 'example.com' }\n", after: "config.cache_classes = true\n"
+
+# Add our local Active Admin to the load path
+inject_into_file "config/environment.rb",
+                 "\n$LOAD_PATH.unshift('#{File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'lib'))}')\nrequire \"active_admin\"\n",
+                 after: "require File.expand_path('../application', __FILE__)"
+
+run "rm Gemfile"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+generate :'active_admin:install --skip-users'
+generate :'formtastic:install'
+
+# Initialize plugin
+inject_into_file "config/initializers/active_admin.rb",
+                 "  config.before_action do\n    left_sidebar!(collapsed: true) if respond_to?(:left_sidebar!)\n  end\n\n",
+                 after: "ActiveAdmin.setup do |config|\n"
+
+inject_into_file "app/assets/stylesheets/active_admin.scss",
+                 "@import \"active_admin_sidebar\";\n",
+                 after: "@import \"active_admin/base\";\n"
+
+inject_into_file "app/assets/javascripts/active_admin.js.coffee",
+                 "#= require active_admin_sidebar\n",
+                 after: "#= require active_admin/base\n"
+
+run "rm -r test"
+run "rm -r spec"
+
+route "root :to => 'admin/dashboard#index'"
+
+rake "db:migrate"

tasks/test.rake

@@ -0,0 +1,6 @@
+desc "Creates a test rails app for the specs to run against"
+task :setup do
+  require 'rails/version'
+  system("mkdir spec/rails") unless File.exists?("spec/rails")
+  system "bundle exec rails new spec/rails/rails-#{Rails::VERSION::STRING} -m spec/support/rails_template.rb --skip-spring"
+end