active_admin_csv_with_bom 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4546f335b5ab8c9817de0237e95a1d33b610835
+  data.tar.gz: 4a5840dcfa8d2c1a513eaa198c7402ac596b68e1
+SHA512:
+  metadata.gz: 6c281372b40f6036de637d155fd37bea0fd44cc0bfee83523198995900826d2f54dde2c21dc46130531c4448299006627a88ad08b12cc9682c73de294ba57ac9
+  data.tar.gz: e68c47f64fe54a87a7513e97adcc2fefda30fc13798d451b2d5bc28f0cc3b40e03bf12a3a56918d4c02f3d2faa27dfb2423e2c3e0d5452c24dddc92c6fb30094

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/rails/
+/spec/reports/
+/tmp/
+/gemfiles/*.gemfile.lock
+/gemfiles/vendor/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,16 @@
+inherit_from:
+  - .ruby-style.yml
+
+AllCops:
+  Exclude:
+    - "bin/*"
+    - "vendor/**/*"
+    - "gemfiles/**/*"
+    - "spec/rails/**/*"
+    - Gemfile
+    - Rakefile
+  DisplayCopNames: true
+  TargetRubyVersion: 2.1
+
+Metrics/LineLength:
+  Enabled: false

data/.ruby-style.yml

@@ -0,0 +1,242 @@
+AllCops:
+  Exclude:
+    - "vendor/**/*"
+  UseCache: false
+Style/CollectionMethods:
+  Description: Preferred collection methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
+  Enabled: true
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    find: detect
+    find_all: select
+    reduce: inject
+Style/DotPosition:
+  Description: Checks the position of the dot in multi-line method calls.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
+  Enabled: true
+  EnforcedStyle: trailing
+  SupportedStyles:
+  - leading
+  - trailing
+Style/FileName:
+  Description: Use snake_case for source file names.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
+  Enabled: false
+  Exclude: []
+Style/GuardClause:
+  Description: Check for conditionals that can be replaced with guard clauses
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  Enabled: false
+  MinBodyLength: 1
+Style/IfUnlessModifier:
+  Description: Favor modifier if/unless usage when you have a single-line body.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
+  Enabled: false
+  MaxLineLength: 80
+Style/OptionHash:
+  Description: Don't use option hashes when you can use keyword arguments.
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
+  Enabled: false
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "()"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+Style/PredicateName:
+  Description: Check the names of predicate methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  NamePrefixBlacklist:
+  - is_
+  Exclude:
+  - spec/**/*
+Style/RaiseArgs:
+  Description: Checks the arguments passed to raise/fail.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
+  Enabled: false
+  EnforcedStyle: exploded
+  SupportedStyles:
+  - compact
+  - exploded
+Style/SignalException:
+  Description: Checks for proper usage of fail and raise.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  Enabled: false
+  EnforcedStyle: semantic
+  SupportedStyles:
+  - only_raise
+  - only_fail
+  - semantic
+Style/SingleLineBlockParams:
+  Description: Enforces the names of some block params.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
+  Enabled: false
+  Methods:
+  - reduce:
+    - a
+    - e
+  - inject:
+    - a
+    - e
+Style/SingleLineMethods:
+  Description: Avoid single-line methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
+  Enabled: false
+  AllowIfMethodIsEmpty: true
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
+  Enabled: true
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/StringLiteralsInInterpolation:
+  Description: Checks if uses of quotes inside expressions in interpolated strings
+    match the configured preference.
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - consistent_comma
+  - no_comma
+Style/TrailingCommaInLiteral:
+  Description: 'Checks for trailing comma in array and hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - consistent_comma
+  - no_comma
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and
+    conditions.
+  Enabled: false
+  Max: 15
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+  CountComments: false
+  Max: 100
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 100
+  Description: Avoid modules longer than 100 lines of code.
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test
+    cases needed to validate a method.
+  Enabled: false
+  Max: 6
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: false
+  CountComments: false
+  Max: 10
+Metrics/ParameterLists:
+  Description: Avoid parameter lists longer than three or four parameters.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
+  Enabled: false
+  Max: 5
+  CountKeywordArgs: true
+Metrics/PerceivedComplexity:
+  Description: A complexity metric geared towards measuring complexity for a human
+    reader.
+  Enabled: false
+  Max: 7
+Lint/AssignmentInCondition:
+  Description: Don't use assignment in conditions.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
+  Enabled: false
+  AllowSafeAssignment: true
+Style/InlineComment:
+  Description: Avoid inline comments.
+  Enabled: false
+Style/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: false
+Style/Alias:
+  Description: Use alias_method instead of alias.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
+  Enabled: false
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+Style/DoubleNegation:
+  Description: Checks for uses of double negation (!!).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
+  Enabled: false
+Style/EachWithObject:
+  Description: Prefer `each_with_object` over `inject` or `reduce`.
+  Enabled: false
+Style/EmptyLiteral:
+  Description: Prefer literals to Array.new/Hash.new/String.new.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
+  Enabled: false
+Style/ModuleFunction:
+  Description: Checks for usage of `extend self` in modules.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
+  Enabled: false
+Style/OneLineConditional:
+  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
+  Enabled: false
+Style/PerlBackrefs:
+  Description: Avoid Perl-style regex back references.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
+  Enabled: false
+Style/Send:
+  Description: Prefer `Object#__send__` or `Object#public_send` to `send`, as `send`
+    may overlap with existing methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#prefer-public-send
+  Enabled: false
+Style/SpecialGlobalVars:
+  Description: Avoid Perl-style global variables.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
+  Enabled: false
+Style/VariableInterpolation:
+  Description: Don't interpolate global, instance and class variables directly in
+    strings.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
+  Enabled: false
+Style/WhenThen:
+  Description: Use when x then ... for one-line cases.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
+  Enabled: false
+Lint/EachWithObjectArgument:
+  Description: Check for immutable argument given to each_with_object.
+  Enabled: true
+Lint/HandleExceptions:
+  Description: Don't suppress exception.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
+  Enabled: false
+Lint/LiteralInCondition:
+  Description: Checks of literals used in conditions.
+  Enabled: false
+Lint/LiteralInInterpolation:
+  Description: Checks for literals used in interpolation.
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.1

data/Appraisals

@@ -0,0 +1,10 @@
+appraise 'rails42' do
+  gem 'rails',       '~> 4.2.0'
+  gem 'activeadmin', '1.0.0.pre4'
+end
+
+appraise 'rails50' do
+  gem 'rails',       '~> 5.0.0'
+  gem 'inherited_resources', github: 'activeadmin/inherited_resources'
+  gem 'activeadmin',         github: 'activeadmin/activeadmin'
+end

data/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rails',       '~> 4.2.0'
+gem 'activeadmin', '1.0.0.pre4'
+
+gem "pry"
+gem 'appraisal'
+
+group :development do
+  gem "rubocop", "~> 0.40.0"
+end
+
+group :test do
+  gem "capybara"
+  gem "rspec-rails"
+  gem "database_cleaner"
+  gem 'shoulda-matchers'
+  gem "sqlite3", platforms: :mri
+  gem "poltergeist"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yoshiyuki Hirano
+
+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,13 @@
+# ActiveAdminCsvWithBom
+
+Generate csv with byte order mark for Active Admin
+
+## Installation
+
+```ruby
+gem 'active_admin_csv_with_bom'
+```
+
+## License
+
+[MIT License](http://opensource.org/licenses/MIT)

data/Rakefile

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

data/active_admin_csv_with_bom.gemspec

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__), "lib", "active_admin_csv_with_bom", "version")
+
+Gem::Specification.new do |gem|
+  gem.name          = "active_admin_csv_with_bom"
+  gem.version       = ActiveAdminCsvWithBom::VERSION
+  gem.authors       = ["Yoshiyuki Hirano"]
+  gem.email         = ["yhirano@me.com"]
+
+  gem.summary       = "Generate csv with byte order mark for Active Admin"
+  gem.description   = gem.summary
+  gem.homepage      = "https://github.com/yhirano55/active_admin_csv_with_bom"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = ">= 2.1.0"
+
+  gem.add_dependency "activeadmin", ">= 1.0.0.pre4"
+
+  gem.add_development_dependency "bundler", "~> 1.13"
+  gem.add_development_dependency "rake",    "~> 10.0"
+end

data/app/views/active_admin/page/index.csv.ruby

@@ -0,0 +1 @@
+::ActiveAdminCsvWithBom.build(collection)

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_DISABLE_SHARED_GEMS: "true"

data/gemfiles/rails42.gemfile

@@ -0,0 +1,23 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.2.0"
+gem "activeadmin", "1.0.0.pre4"
+gem "pry"
+gem "appraisal"
+
+group :development do
+  gem "rubocop", "~> 0.40.0"
+end
+
+group :test do
+  gem "capybara"
+  gem "rspec-rails"
+  gem "database_cleaner"
+  gem "shoulda-matchers"
+  gem "sqlite3", :platforms => :mri
+  gem "poltergeist"
+end
+
+gemspec :path => "../"

data/gemfiles/rails50.gemfile

@@ -0,0 +1,24 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.0.0"
+gem "activeadmin", :github => "activeadmin/activeadmin"
+gem "pry"
+gem "appraisal"
+gem "inherited_resources", :github => "activeadmin/inherited_resources"
+
+group :development do
+  gem "rubocop", "~> 0.40.0"
+end
+
+group :test do
+  gem "capybara"
+  gem "rspec-rails"
+  gem "database_cleaner"
+  gem "shoulda-matchers"
+  gem "sqlite3", :platforms => :mri
+  gem "poltergeist"
+end
+
+gemspec :path => "../"

data/lib/active_admin_csv_with_bom.rb

@@ -0,0 +1,23 @@
+require "active_admin"
+require "active_admin_csv_with_bom/builder"
+require "active_admin_csv_with_bom/engine"
+
+module ActiveAdminCsvWithBom
+  # NOTE: For resource of **NOT** Active Record
+  def self.build(collection)
+    Builder.new(collection).build
+  end
+
+  def self.csv_options
+    @_csv_options ||= {
+      byte_order_mark:  "\xFF\xFE".force_encoding("UTF-16LE").freeze,
+      encoding:         "UTF-16LE",
+      encoding_options: "UTF-8",
+      col_sep:          "\t",
+      row_sep:          "\r\n",
+      force_quotes:     true
+    }
+  end
+end
+
+ActiveAdmin::Application.inheritable_setting(:csv_options, ActiveAdminCsvWithBom.csv_options)

data/lib/active_admin_csv_with_bom/builder.rb

@@ -0,0 +1,59 @@
+require "csv"
+require "ostruct"
+require "active_support/core_ext/module/delegation"
+
+module ActiveAdminCsvWithBom
+  class Builder
+    attr_reader :collection
+
+    delegate :byte_order_mark, :encoding, :encoding_options,
+             :col_sep, :row_sep, :force_quotes, to: :config
+
+    def initialize(collection)
+      @collection = collection
+    end
+
+    def build
+      "".tap do |csv|
+        csv << byte_order_mark
+        csv << build_header
+
+        collection.each do |record|
+          csv << build_row(record)
+        end
+      end
+    end
+
+    private
+
+    def build_header
+      CSV.generate_line(column_names.map { |name| encode(resource_class.human_attribute_name(name)) }, options)
+    end
+
+    def build_row(record)
+      CSV.generate_line(column_names.map { |name| encode(record.send(name)) }, options)
+    end
+
+    def resource_class
+      @_resource_class ||= collection[0].class
+    end
+
+    def column_names
+      @_column_names ||= resource_class.column_names
+    rescue NoMethodError => _e
+      raise NotImplementedError, "you must implement #{resource_class}.column_names"
+    end
+
+    def encode(value)
+      value.to_s.encode(encoding, encoding_options)
+    end
+
+    def options
+      @_options ||= { col_sep: col_sep, row_sep: row_sep, force_quotes: force_quotes }
+    end
+
+    def config
+      @_config ||= OpenStruct.new(::ActiveAdminCsvWithBom.csv_options)
+    end
+  end
+end

data/lib/active_admin_csv_with_bom/engine.rb

@@ -0,0 +1,6 @@
+require "rails/engine"
+
+module ActiveAdminCsvWithBom
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/active_admin_csv_with_bom/version.rb

@@ -0,0 +1,3 @@
+module ActiveAdminCsvWithBom
+  VERSION = "0.1.0".freeze
+end

data/tasks/test.rake

@@ -0,0 +1,10 @@
+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")
+  system "bundle exec rails new spec/rails/rails-#{Rails::VERSION::STRING} -m spec/support/rails_template.rb --skip-spring  --skip-turbolinks"
+end
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: active_admin_csv_with_bom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoshiyuki Hirano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeadmin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Generate csv with byte order mark for Active Admin
+email:
+- yhirano@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-style.yml"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_admin_csv_with_bom.gemspec
+- app/views/active_admin/page/index.csv.ruby
+- gemfiles/.bundle/config
+- gemfiles/rails42.gemfile
+- gemfiles/rails50.gemfile
+- lib/active_admin_csv_with_bom.rb
+- lib/active_admin_csv_with_bom/builder.rb
+- lib/active_admin_csv_with_bom/engine.rb
+- lib/active_admin_csv_with_bom/version.rb
+- tasks/test.rake
+homepage: https://github.com/yhirano55/active_admin_csv_with_bom
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Generate csv with byte order mark for Active Admin
+test_files: []