activeadmin-xls 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3cefe4337bc929cc027541a8b378764fcee9c29
-  data.tar.gz: 6ece12827ba7c2e0b85772b357c368a29d973c51
+  metadata.gz: a30a7f1fc93455cecb1aac5d28026454061ebdcd
+  data.tar.gz: a1342476206f3a3b7ba04c15df545d620af315eb
 SHA512:
-  metadata.gz: a505457094d423aad3857be11f8aaf26adafa48957678296019324c15736be6bc89c40be0b41e4e3ea79ed17d9abd205e4463937aca9f40618193bf7eb3e8de4
-  data.tar.gz: 689a4ae242134e3cc0e7d7729b539eadca9349bbd141431422b7f0a83b10be7b3f72012ec60c92019b036973b9debe6f3e0b9ef947d35f815a51bb2dffb9c4a2
+  metadata.gz: acd27c54cbf49c5148d94625f4872b89291513fbea277ff8fb0e96231a40ce8172fb9cae4d91ad4e1adeda135ce45feb704a5396a2c66252a49f97abf3ab9de8
+  data.tar.gz: 9baa56bf539d13050c67b6a9e911323a0d5bd04bd43b6182eb32f0de4e6c125aaca61b32adafa86addd387072d751db5497f1b3273320abbd2aa044912b19f0e

data/.gitignore

@@ -1,7 +1,7 @@
 spec/rails
 *.gem
 coverage
-*.xlsx
+*.xls
 doc
 *.un~
 .yardoc

data/CHANGELOG.md

@@ -1,33 +1,52 @@
 # Changelog
 
+## [Unreleased]
+
+## 1.1.0
+
+### Added
+
+* Add only_columns [#7][]
+
+### Fixed
+
+* Fix typo in README.md [#11][] by [@cpunion][]
+
+### Changed
+
+* Update tests for ActiveAdmin 1.2
+
 ## 1.0.5
 
-### Updates
+### Fixed
 
 * Fix #1 - Unnecessary database access
 * Fix broken tests
 
 ## 1.0.4
 
-### Updates
+### Fixed
 
 * Minor bug fixes / typo corrections
 
 ## 1.0.3
 
-### Updates
+### Fixed
 
 * Move require rake from gemspec to lib/activeadmin-xls.rb [#4][] by [@ejaypcanaria][]
 
 ## 1.0.2
 
-### Bug Fixes
+### Fixed
 
 * Fixes undefined local variable or `method max_per_page` [#3][] by [@rewritten][]
 
 <!--- Link List --->
 [#3]: https://github.com/thambley/activeadmin-xls/issues/3
 [#4]: https://github.com/thambley/activeadmin-xls/pull/4
+[#7]: https://github.com/thambley/activeadmin-xls/issues/7
+[#11]: https://github.com/thambley/activeadmin-xls/pull/11
 
 [@rewritten]: https://github.com/rewritten
 [@ejaypcanaria]: https://github.com/ejaypcanaria
+[@cpunion]: https://github.com/cpunion

data/README.md

@@ -1,16 +1,8 @@
-# Active Admin Xls: Excel Spreadsheet Export for Active Admin
+# Active Admin Xls
 
-**Git**: [http://github.com/thambley/activeadmin-xls](http://github.com/thambley/activeadmin-xls)
+Excel Spreadsheet Export for [Active Admin](https://www.activeadmin.info/)
 
-**Author**:  Todd Hambley
-
-**Copyright**:    2014 ~ 2017
-
-**License**: MIT License
-
-**Latest Version**: 1.0.4
-
-**Release Date**: 2017.11.22
+[![Gem Version](https://badge.fury.io/rb/activeadmin-xls.svg)](https://badge.fury.io/rb/activeadmin-xls)
 
 ## Synopsis
 
@@ -25,10 +17,16 @@ All resource index views will now include a link for download directly
 to xls.
 
 ```ruby
-gem 'activeadmin-xls'
+gem 'activeadmin-xls', '~>1.1.0'
+```
+
+For Active Admin 1.0, you will also have to update config/initializers/active_admin.rb.  Update the download\_links setting to include xls:
+
+```ruby
+config.download_links = %i[csv xml json xls]
 ```
 
-## Cool Toys
+## Examples
 
 Here are a few quick examples of things you can easily tweak.
 
@@ -71,6 +69,15 @@ ActiveAdmin.register Post do
 end
 ```
 
+### Restrict columns to a list
+
+```ruby
+# app/admin/posts.rb
+ActiveAdmin.register Post do
+  config.xls_builder.only_columns :title, :author
+end
+```
+
 ## Using the DSL
 
 Everything that you do with the config's default builder can be done via
@@ -91,10 +98,13 @@ ActiveAdmin.register Post do
     # Do not serialize the header, only output data.
     # skip_header
 
+    # restrict columns to a list without customization
+    # only_columns :title, :author
+
     # deleting columns from the report
     delete_columns :id, :created_at, :updated_at
 
-    # adding a column to the report
+    # adding a column to the report with customization
     column(:author) { |post| "#{post.author.first_name} #{post.author.last_name}" }
 
     # inserting additional data with after_filter
@@ -110,7 +120,7 @@ ActiveAdmin.register Post do
 end
 ```
 
-## Specs
+## Testing
 
 Running specs for this gem requires that you construct a rails application.
 
@@ -143,9 +153,3 @@ BUNDLE_GEMFILE=gemfiles/rails_42.gemfile bundle exec rake setup
 ```text
 BUNDLE_GEMFILE=gemfiles/rails_42.gemfile bundle exec rake
 ```
-
-## Copyright and License
-
-activeadmin-xls © 2014 by [Todd Hambley](mailto:thambley@travelleaders.com).
-
-activeadmin-xls is licensed under the MIT license. Please see the LICENSE document for more information.

data/Rakefile

@@ -1,11 +1,11 @@
 #!/usr/bin/env rake
+require File.expand_path('../lib/active_admin/xls/version', __FILE__)
 require 'rspec/core/rake_task'
 
 desc 'Creates a test rails app for the specs to run against'
 task :setup do
   require 'rails/version'
   system('mkdir spec/rails') unless File.exist?('spec/rails')
-  puts "system \"bundle exec rails new spec/rails/rails-#{Rails::VERSION::STRING} -m spec/support/rails_template_with_data.rb\""
   system "bundle exec rails new spec/rails/rails-#{Rails::VERSION::STRING} -m spec/support/rails_template_with_data.rb"
 end
 
@@ -17,6 +17,7 @@ desc 'build the gem'
 task :build do
   system 'gem build activeadmin-xls.gemspec'
 end
+
 desc 'build and release the gem'
 task release: :build do
   system "gem push activeadmin-xls-#{ActiveAdmin::Xls::VERSION}.gem"

data/gemfiles/rails_42.gemfile

@@ -6,7 +6,7 @@ ruby_minor_version = RUBY_VERSION.split('.')[1].to_i
 
 eval_gemfile(File.expand_path(File.join('..', 'Gemfile'), __dir__))
 
-gem 'activeadmin', '1.0.0'
+gem 'activeadmin', '1.2.1'
 gem 'devise', '~> 4.2'
 gem 'rails', '4.2.10'
 gem 'turbolinks', '~> 5.0.0'

data/lib/active_admin/xls/builder.rb

@@ -26,7 +26,7 @@ module ActiveAdmin
       #
       #     }
       #   end
-      #   @see ActiveAdmin::Axlsx::DSL
+      #   @see ActiveAdmin::xls::DSL
       def initialize(resource_class, options = {}, &block)
         @skip_header = false
         @resource_class = resource_class
@@ -138,6 +138,15 @@ module ActiveAdmin
         end
       end
 
+      # remove all columns, and add columns by name
+      # each column_name should be a symbol
+      def only_columns(*column_names)
+        clear_columns
+        column_names.each do |column_name|
+          column column_name
+        end
+      end
+
       # Serializes the collection provided
       # @return [Spreadsheet::Workbook]
       def serialize(collection, view_context = nil)

data/lib/active_admin/xls/dsl.rb

@@ -9,6 +9,7 @@ module ActiveAdmin
                :header_format,
                :header_style,
                :i18n_scope,
+               :only_columns,
                :skip_header,
                :whitelist,
                to: :xls_builder,

data/lib/active_admin/xls/engine.rb

@@ -13,7 +13,10 @@ module ActiveAdmin
 
         ActiveAdmin::ResourceDSL.send :include, ActiveAdmin::Xls::DSL
         ActiveAdmin::Resource.send :include, ActiveAdmin::Xls::ResourceExtension
-        ActiveAdmin::ResourceController.send :include, ActiveAdmin::Xls::ResourceControllerExtension
+        ActiveAdmin::ResourceController.send(
+          :include,
+          ActiveAdmin::Xls::ResourceControllerExtension
+        )
       end
     end
   end

data/lib/active_admin/xls/version.rb

@@ -1,5 +1,5 @@
 module ActiveAdmin
   module Xls
-    VERSION = '1.0.5'.freeze
+    VERSION = '1.1.0'.freeze
   end
 end

data/spec/support/rails_template.rb

@@ -10,9 +10,11 @@ gsub_file 'config/database.yml', /^test:.*\n/, "test: &test\n"
 gsub_file 'config/database.yml',
           /\z/,
           "\ncucumber:\n  <<: *test\n  database: db/cucumber.sqlite3"
-gsub_file 'config/database.yml',
-          /\z/,
-          "\ncucumber_with_reloading:\n  <<: *test\n  database: db/cucumber.sqlite3"
+gsub_file(
+  'config/database.yml',
+  /\z/,
+  "\ncucumber_with_reloading:\n  <<: *test\n  database: db/cucumber.sqlite3"
+)
 
 # Generate some test models
 generate :model, 'post title:string body:text published_at:datetime author_id:integer category_id:integer'
@@ -20,26 +22,36 @@ inject_into_file 'app/models/post.rb', "  belongs_to :author, class_name: 'User'
 # Rails 3.2.3 model generator declare attr_accessible
 if Rails::VERSION::MAJOR == 3
   inject_into_file 'app/models/post.rb',
-                  "  attr_accessible :author\n",
-                  before: 'end'
+                   "  attr_accessible :author\n",
+                   before: 'end'
 end
 generate :model, 'user type:string first_name:string last_name:string username:string age:integer'
-inject_into_file 'app/models/user.rb', "  has_many :posts, foreign_key: 'author_id'\n", after: "class User < ActiveRecord::Base\n"
+inject_into_file 'app/models/user.rb',
+                 "  has_many :posts, foreign_key: 'author_id'\n",
+                 after: "class User < ActiveRecord::Base\n"
 generate :model, 'publisher --migration=false --parent=User'
 generate :model, 'category name:string description:text'
-inject_into_file 'app/models/category.rb', "  has_many :posts\n  accepts_nested_attributes_for :posts\n", after: "class Category < ActiveRecord::Base\n"
+inject_into_file 'app/models/category.rb',
+                 "  has_many :posts\n  accepts_nested_attributes_for :posts\n",
+                 after: "class Category < ActiveRecord::Base\n"
 generate :model, 'store name:string'
 
 # Generate a model with string ids
 generate :model, 'tag name:string'
-gsub_file(Dir['db/migrate/*_create_tags.rb'][0], /\:tags\sdo\s.*/, ":tags, id: false, primary_key: :id do |t|\n\t\t\tt.string :id\n" )
+gsub_file(
+  Dir['db/migrate/*_create_tags.rb'][0],
+  /\:tags\sdo\s.*/,
+  ":tags, id: false, primary_key: :id do |t|\n\t\t\tt.string :id\n"
+)
 id_model_setup = <<-MODEL
   self.primary_key = :id
   before_create :set_id
 
   private
   def set_id
-    self.id = 8.times.inject('') { |s,e| s << (i = Kernel.rand(62); i += ((i < 10) ? 48 : ((i < 36) ? 55 : 61 ))).chr }
+    self.id = 8.times.inject('') do |s,e|
+      s << (i = Kernel.rand(62); i += ((i < 10) ? 48 : ((i < 36) ? 55 : 61 ))).chr
+    end
   end
 MODEL
 
@@ -54,14 +66,16 @@ if Rails::VERSION::MAJOR == 3 && Rails::VERSION::MINOR == 1 # Rails 3.1 Gotcha
 end
 
 # 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"
+inject_into_file(
+  'config/environments/test.rb',
+  "  config.action_mailer.default_url_options = { host: 'example.com' }\n",
+  after: "config.cache_classes = true\n"
+)
 
-puts File.expand_path('../../../lib/activeadmin-xls', __FILE__)
+lib_path = File.expand_path('../../../lib/activeadmin-xls', __FILE__)
 # Add our local Active Admin to the load path
 inject_into_file 'config/environment.rb',
-                 "\nrequire \"#{File.expand_path('../../../lib/activeadmin-xls', __FILE__)}\"\n",
+                 "\nrequire '#{lib_path}'\n",
                  after: "require File.expand_path('../application', __FILE__)"
 
 # Add some translations

data/spec/support/rails_template_with_data.rb

@@ -10,35 +10,41 @@ scopes = <<-SCOPES
   scope :all, default: true
 
   scope :drafts do |posts|
-    posts.where(["published_at IS NULL"])
+    posts.where(['published_at IS NULL'])
   end
 
   scope :scheduled do |posts|
-    posts.where(["posts.published_at IS NOT NULL AND posts.published_at > ?", Time.now.utc])
+    posts.where(['posts.published_at IS NOT NULL AND posts.published_at > ?', Time.now.utc])
   end
 
   scope :published do |posts|
-    posts.where(["posts.published_at IS NOT NULL AND posts.published_at < ?", Time.now.utc])
+    posts.where(['posts.published_at IS NOT NULL AND posts.published_at < ?', Time.now.utc])
   end
 
   scope :my_posts do |posts|
-    posts.where(:author_id => current_admin_user.id)
+    posts.where(author_id: current_admin_user.id)
   end
 SCOPES
 
-inject_into_file 'app/admin/post.rb',
-                 scopes,
-                 after: "ActiveAdmin.register Post do\n"
+if File.exist?('app/admin/post.rb')
+  inject_into_file 'app/admin/post.rb',
+                   scopes,
+                   after: "ActiveAdmin.register Post do\n"
+else
+  inject_into_file 'app/admin/posts.rb',
+                   scopes,
+                   after: "ActiveAdmin.register Post do\n"
+end
 
 # Setup some default data
 append_file 'db/seeds.rb', <<-SEEDS
 
   users = ['Jimi Hendrix', 'Jimmy Page', 'Yngwie Malmsteen', 'Eric Clapton', 'Kirk Hammett'].collect do |name|
     first, last = name.split(" ")
-    User.create!  first_name: first,
-                  last_name: last,
-                  username: [first,last].join('-').downcase,
-                  age: rand(80)
+    User.create! first_name: first,
+                 last_name: last,
+                 username: [first, last].join('-').downcase,
+                 age: rand(80)
   end
 
   categories = ['Rock', 'Pop Rock', 'Alt-Country', 'Blues', 'Dub-Step'].collect do |name|

data/spec/xls/unit/builder_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 module ActiveAdmin
+  # tests for builder
   module Xls
     describe Builder do
       let(:builder) { Builder.new(Post) }
@@ -24,6 +25,11 @@ module ActiveAdmin
           expect(builder.columns.size).to eq(content_columns.size - 1)
         end
 
+        it 'lets us use specific columns in a list' do
+          builder.only_columns :title, :author
+          expect(builder.columns.size).to eq(2)
+        end
+
         it 'lets us say we dont want the header' do
           builder.skip_header
           expect(builder.instance_values['skip_header']).to be_truthy
@@ -53,7 +59,9 @@ module ActiveAdmin
           end
 
           it 'evaluates custom column blocks' do
-            expect(builder.columns.last.data.call(post)).to eq('Hot Dawg - with cheese')
+            expect(builder.columns.last.data.call(post)).to eq(
+              'Hot Dawg - with cheese'
+            )
           end
         end
       end
@@ -61,10 +69,16 @@ module ActiveAdmin
       context 'sheet generation without headers' do
         let!(:users) { [User.new(first_name: 'bob', last_name: 'nancy')] }
 
-        let!(:posts) { [Post.new(title: 'bob', body: 'is a swell guy', author: users.first)] }
+        let!(:posts) do
+          [Post.new(title: 'bob', body: 'is a swell guy', author: users.first)]
+        end
 
         let!(:builder) do
-          Builder.new(Post, header_format: { weight: :bold }, i18n_scope: %i[xls post]) do
+          options = {
+            header_format: { weight: :bold },
+            i18n_scope: %i[xls post]
+          }
+          Builder.new(Post, options) do
             skip_header
           end
         end
@@ -117,7 +131,11 @@ module ActiveAdmin
 
       context 'Sheet generation with a highly customized configuration.' do
         let!(:builder) do
-          Builder.new(Post, header_style: { size: 10, color: 'red' }, i18n_scope: %i[xls post]) do
+          options = {
+            header_style: { size: 10, color: 'red' },
+            i18n_scope: %i[xls post]
+          }
+          Builder.new(Post, options) do
             delete_columns :id, :created_at, :updated_at
             column(:author) do |resource|
               "#{resource.author.first_name} #{resource.author.last_name}"
@@ -178,7 +196,9 @@ module ActiveAdmin
 
         it 'translates the header row based on our i18n scope' do
           header_row = @book.worksheets.first.row(2)
-          expect(header_row).to eq(['Title', 'Content', 'Published On', 'Publisher'])
+          expect(header_row).to eq(
+            ['Title', 'Content', 'Published On', 'Publisher']
+          )
         end
 
         it 'processes the before filter' do

data/spec/xls/unit/dsl_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 module ActiveAdmin
+  # tests for dsl
   module Xls
     describe ::ActiveAdmin::ResourceDSL do
       context 'in a registration block' do
@@ -42,6 +43,7 @@ module ActiveAdmin
         it 'has a before filter set' do
           expect(builder.instance_values['before_filter']).to be_a(Proc)
         end
+
         it 'has an after filter set' do
           expect(builder.instance_values['after_filter']).to be_a(Proc)
         end

data/spec/xls/unit/resource_controller_spec.rb

@@ -43,7 +43,7 @@ describe ActiveAdmin::ResourceController do
       expect(controller.send(:per_page)).to eq(max_csv_records)
     end
 
-    it 'uses to the default per_page when we do not specify xls mime type' do
+    it 'uses the default per_page when we do not specify xls mime type' do
       controller.request.accept = 'text/html'
       aa_default_per_page = ActiveAdmin.application.default_per_page
       expect(controller.send(:per_page)).to eq(aa_default_per_page)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activeadmin-xls
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Todd Hambley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-29 00:00:00.000000000 Z
+date: 2018-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeadmin