serialism 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a8da01fff2518ac843e20e413b6316fde7ac376
-  data.tar.gz: 9ce3c2b30174352c5347510ae20bf1a0fe5774bf
+  metadata.gz: 811ef6562b6145708c14e43e3a1f0e251a612c62
+  data.tar.gz: ec066137b81c602616ff0658607a70845517aa42
 SHA512:
-  metadata.gz: bf44d446ca14577c76edcaec7154eaa8dad1cdc32b34a7b409b19fd7ae06c69f6c5ff79a25420c58f55d0fe63d4dcbeb0fedbbb77bd2cce8338fda158e522fb3
-  data.tar.gz: 8319e027cc4e276bab9e6073819ac17cc42d124ff41d396923bd384ce01327f0c037d7e44ebc58230deec06b70f552c3641a47980c490ad1c07303d9112f83e3
+  metadata.gz: 4a53c543ddd5ed7eb6963d7407ec2c3c65f98d248f4f3e27f3a743379d6c4087615d6bc2fb6474b55137a16b20bb2ffa40f6c8739f283b1134a7a391bd1f60c2
+  data.tar.gz: eca29236444736a482b97d08f8637c064bd1cc14c4b2e42ef08186c7994538551091f801a4ded5085fc342f26622f90c9a84e0efec74133361c126af20fe7471

data/.gitignore

@@ -1,5 +1,6 @@
 /.bundle/
 /.yardoc
+/.rubocop-http*
 /Gemfile.lock
 /_yardoc/
 /coverage/

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+inherit_from:
+  - https://raw.githubusercontent.com/tedconf/code-style-guides/master/linters/rubocop/rubocop.yml

data/.ruby-gemset

@@ -0,0 +1 @@
+serialism

data/.ruby-version

@@ -0,0 +1 @@
+2.3.7

data/Guardfile

@@ -24,8 +24,8 @@
 #  * zeus: 'zeus rspec' (requires the server to be started separately)
 #  * 'just' rspec: 'rspec'
 
-guard :rspec, cmd: "bundle exec rspec" do
-  require "guard/rspec/dsl"
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)
 
   # Feel free to open issues for suggestions and improvements

data/Jenkinsfile

@@ -0,0 +1,3 @@
+rubyBuild {
+  job_type = 'gem'
+}

data/Rakefile

@@ -1,2 +1,10 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
+require 'rspec/core/rake_task'
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(:spec)
+
+if ENV['COVERAGE']
+  require 'ci/reporter/rake/rspec'
+  task spec: 'ci:setup:rspec'
+end

data/lib/serialism.rb

@@ -1,6 +1,7 @@
-require "serialism/version"
-require "serialism/collection"
-require "serialism/serializer"
+require 'serialism/version'
+require 'serialism/collection'
+require 'serialism/serializer'
 
+# Serialism provides serialization of collections of objects.
 module Serialism
 end

data/lib/serialism/collection.rb

@@ -1,5 +1,4 @@
 module Serialism
-
   # Combines a set of items and a serializer class.
   #
   # Example:
@@ -15,22 +14,21 @@ module Serialism
   #   Serialism::Collection.new(a_bunch_of_foo_instances, serializer: FooSerializer).to_csv
   #   #=> returns a CSV string
   class Collection
-
     attr_reader :items
 
     # create a new collection
     #
-    # @param[Enumerable] items
+    # @param [Enumerable] items
     #    A collection of items.
     #    All member items should be encodable by `serializer`.
-    # @param[Serialism::Serializer] serializer
+    # @param [Serialism::Serializer] serializer
     #    The serializer class used to encode members of `items`.
-    def initialize(items=[], serializer:)
-      if ! serializer.respond_to?(:attributes)
-        raise ArgumentError, "serializer must implement a class-level :attributes method"
+    def initialize(items = [], serializer:)
+      if !serializer.respond_to?(:attributes)
+        raise ArgumentError, 'serializer must implement a class-level :attributes method'
       end
-      if ! serializer.instance_methods.include?(:render)
-        raise ArgumentError, "serializer must implement an instance-level :render method"
+      if !serializer.instance_methods.include?(:render)
+        raise ArgumentError, 'serializer must implement an instance-level :render method'
       end
       @serializer = serializer
 
@@ -42,10 +40,10 @@ module Serialism
     # Replaces any previous items already in the collection.
     #
     # @param [#each] items an enumerable collection of items
-    # @return [CsvCollection]
+    # @return [Serialism::Collection]
     def items=(items)
-      raise ArgumentError, "argument must respond_to :each" if ! items.respond_to?(:each)
-      raise ArgumentError, "argument must respond_to :map" if ! items.respond_to?(:map)
+      raise ArgumentError, 'argument must respond_to :each' if !items.respond_to?(:each)
+      raise ArgumentError, 'argument must respond_to :map' if !items.respond_to?(:map)
 
       @items = items
       self
@@ -55,7 +53,7 @@ module Serialism
     #
     # @return [Array]
     def attributes
-      return [] if items.size == 0
+      return [] if items.empty?
 
       @serializer.attributes
     end
@@ -72,14 +70,8 @@ module Serialism
 
       CSV.generate do |csv|
         csv << attributes
-        items.each do |t|
-
-          row = @serializer.new(t).render.values.map do |cell|
-            # convert complex cells to comma-separated strings
-            cell.is_a?(Array) ? cell.join(',') : cell
-          end
-
-          csv << row
+        items.map do |i|
+          csv << render_row(i)
         end
       end
     end
@@ -87,8 +79,21 @@ module Serialism
     def to_json
       require 'json'
 
-      JSON.dump(items.map {|t| @serializer.new(t).render })
+      JSON.dump(items.map { |t| @serializer.new(t).render })
     end
 
+    # this generates an array of arrays
+    # headers are [0] data starts at [1]
+    def to_a
+      [attributes] + items.map { |i| render_row(i) }
+    end
+
+    private
+
+    def render_row(row)
+      @serializer.new(row).render.values.map do |cell|
+        cell.is_a?(Array) ? cell.join(',') : cell
+      end
+    end
   end
 end

data/lib/serialism/serializer.rb

@@ -1,5 +1,4 @@
 module Serialism
-
   # Base class for concrete serializers to inherit from.
   #
   # Example:
@@ -23,14 +22,11 @@ module Serialism
   #   serializer.render
   #   # => {id: 12, computed: "computed - 12"}
   class Serializer
-
     attr_reader :object
 
     @attributes = []
     def self.attributes(*attrs)
-      if attrs.size > 0
-        @attributes = attrs
-      end
+      @attributes = attrs if !attrs.empty?
       @attributes
     end
 
@@ -42,9 +38,9 @@ module Serialism
     #
     # @return [Hash] Keys are defined by the classes `attributes`.
     def render
-      self.class.attributes.inject({}) do |memo,attr|
+      self.class.attributes.inject({}) do |memo, attr|
         if respond_to?(attr)
-          memo[attr] = self.send(attr)
+          memo[attr] = send(attr)
         elsif object.respond_to?(attr)
           memo[attr] = object.send(attr)
         else
@@ -53,7 +49,5 @@ module Serialism
         memo
       end
     end
-
   end
-
 end

data/lib/serialism/version.rb

@@ -1,3 +1,3 @@
 module Serialism
-  VERSION = "0.0.1"
+  VERSION = '0.2.0'.freeze
 end

data/script/jenkins.sh

@@ -0,0 +1,66 @@
+#!/bin/bash
+
+# Template Jenkins Wrapper for Language: 'Ruby'
+
+# Setup our ruby and gemset
+source /usr/local/rvm/scripts/rvm
+type rvm | head -1
+
+# Use our gemset (create it if it doesn't already exist)
+ruby_version=`cat .ruby-version | tr -d '\n'`
+ruby_gemset=`cat .ruby-gemset | tr -d '\n'`
+
+rvm use "${ruby_version}@${ruby_gemset}" --create
+
+# Make sure bundler is installed for this ruby version/gemset
+gem list bundler -i >/dev/null 2>&1
+if [ $? -eq 1 ]; then
+  echo "Installing bundler"
+  gem install bundler
+fi
+
+# Ensure we have ruby
+ruby --version
+echo "Ruby Gemset:"
+rvm current
+echo ""
+
+# Print all commands after expansion.  Note that you can put this earlier
+# in the script, but rvm prints out a wall-o-text.
+set -x
+
+# Good to know the path
+echo "PATH is ${PATH}"
+
+# any non-normal exit status from now on should fail the build
+set -e
+
+# Update all our gems
+bundle install
+
+export COVERAGE=on
+bundle exec rake spec
+
+# check for style violations
+# never fail the build at this step. let a jenkins post-build action do this
+# if necessary
+#
+# output:
+#   print clang format to stdout, which ends up in jenkins console
+#   create html version in build/ for viewing from jenkins web UI.
+#   print checkstyle.xml for consumption by jenkins checkstyle plugin
+bundle exec rubocop \
+  --require rubocop/formatter/checkstyle_formatter \
+  --display-cop-names \
+  --format clang \
+  --format html \
+  --out build/rubocop.html \
+  --format RuboCop::Formatter::CheckstyleFormatter \
+  --out tmp/checkstyle.xml || true
+
+# Security check
+ignores=""
+bundle exec bundle-audit update
+bundle exec bundle-audit check --ignore=${ignores}
+
+exit 0

data/serialism.gemspec

@@ -1,27 +1,30 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'serialism/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "serialism"
+  spec.name          = 'serialism'
   spec.version       = Serialism::VERSION
-  spec.authors       = ["Alex Dean"]
-  spec.email         = ["alex@crackpot.org"]
-  spec.summary       = %q{Like ActiveModel::Serializer but smaller and not JSON-centric.}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['Alex Dean']
+  spec.email         = ['github@mostlyalex.com']
+  spec.summary       = 'Like ActiveModel::Serializer but smaller and not JSON-centric.'
+  spec.homepage      = 'https://github.com/tedconf/serialism'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0.0"
-  spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "ruby_gntp"
-  spec.add_development_dependency "ci_reporter_rspec"
+  spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'ruby_gntp'
+  spec.add_development_dependency 'ci_reporter_rspec'
+  spec.add_development_dependency 'bundler-audit'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-checkstyle_formatter'
 end

data/spec/lib/serialism/collection_spec.rb

@@ -34,7 +34,12 @@ RSpec.describe Serialism::Collection, type: :model do
 
       expect {
         Serialism::Collection.new([], serializer: invalid_serializer)
-      }.to raise_error(ArgumentError, 'serializer must implement a class-level :attributes method')
+      }.to(
+        raise_error(
+          ArgumentError,
+          'serializer must implement a class-level :attributes method'
+        )
+      )
     end
 
     it 'should require serializer to implement instance-level render' do
@@ -75,6 +80,12 @@ RSpec.describe Serialism::Collection, type: :model do
     it 'should return array of attributes' do
       expect(collection.attributes).to eq serializer.attributes
     end
+
+    it 'should return empty array if no items exist' do
+      expect(
+        Serialism::Collection.new([], serializer: serializer).attributes
+      ).to eq []
+    end
   end
 
   describe 'to_csv' do
@@ -91,8 +102,8 @@ EOF
 
     it 'should encode complex cells as csv strings' do
       collection.items = [
-        serialized.new([1,2,3]),
-        serialized.new([4,5,6])
+        serialized.new([1, 2, 3]),
+        serialized.new([4, 5, 6])
       ]
 
       expected = <<-EOF
@@ -106,7 +117,37 @@ EOF
 
   describe 'to_json' do
     it 'should generate json' do
-      expect(collection.to_json).to eq '[{"id":0,"computed":"computed - 0"},{"id":1,"computed":"computed - 1"},{"id":2,"computed":"computed - 2"}]'
+      expect(collection.to_json).to eq(
+        '[' \
+          '{"id":0,"computed":"computed - 0"},' \
+          '{"id":1,"computed":"computed - 1"},' \
+          '{"id":2,"computed":"computed - 2"}' \
+        ']'
+      )
+    end
+  end
+
+  describe 'to_a' do
+    it 'should generate an array' do
+      expected = [[:id, :computed],
+                  [0, 'computed - 0'],
+                  [1, 'computed - 1'],
+                  [2, 'computed - 2']
+                ]
+      expect(collection.to_a).to eq expected
+    end
+
+    it 'should encode complex cells as csv strings' do
+      collection.items = [
+        serialized.new([1, 2, 3]),
+        serialized.new([4, 5, 6])
+      ]
+
+      expected = [[:id, :computed],
+                  ["1,2,3", "computed - [1, 2, 3]"],
+                  ["4,5,6", "computed - [4, 5, 6]"]
+                 ]
+      expect(collection.to_a).to eq expected
     end
   end
 

data/spec/lib/serialism/serializer_spec.rb

@@ -28,10 +28,10 @@ RSpec.describe Serialism::Serializer, type: :model do
 
     it 'should prefer attribute implementations in the serializer' do
       values = subject.new(item).render
-      expect(values[:computed]).to eq "computed by serializer - 1"
+      expect(values[:computed]).to eq 'computed by serializer - 1'
     end
 
-    it 'should use attribute implementation in the object if not defined explicitly in serializer' do
+    it 'should use attribute implementation in object if not defined explicitly in serializer' do
       values = subject.new(item).render
       expect(values[:id]).to eq 1
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serialism
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex Dean
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-25 00:00:00.000000000 Z
+date: 2018-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,29 +94,77 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-checkstyle_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
-- alex@crackpot.org
+- github@mostlyalex.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
 - Gemfile
 - Guardfile
+- Jenkinsfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- build/.gitkeep
 - lib/serialism.rb
 - lib/serialism/collection.rb
 - lib/serialism/serializer.rb
 - lib/serialism/version.rb
+- script/jenkins.sh
 - serialism.gemspec
 - spec/lib/serialism/collection_spec.rb
 - spec/lib/serialism/serializer_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/tedconf/serialism
 licenses:
 - MIT
 metadata: {}
@@ -136,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Like ActiveModel::Serializer but smaller and not JSON-centric.