serialism 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a8da01fff2518ac843e20e413b6316fde7ac376
+  data.tar.gz: 9ce3c2b30174352c5347510ae20bf1a0fe5774bf
+SHA512:
+  metadata.gz: bf44d446ca14577c76edcaec7154eaa8dad1cdc32b34a7b409b19fd7ae06c69f6c5ff79a25420c58f55d0fe63d4dcbeb0fedbbb77bd2cce8338fda158e522fb3
+  data.tar.gz: 8319e027cc4e276bab9e6073819ac17cc42d124ff41d396923bd384ce01327f0c037d7e44ebc58230deec06b70f552c3641a47980c490ad1c07303d9112f83e3

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in serialism.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,43 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+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
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Alex Dean
+
+MIT License
+
+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,81 @@
+# Serialism
+
+Kinda like (and inspired by) [ActiveModel::Serializer](https://github.com/rails-api/active_model_serializers),
+but with a smaller/simpler feature set and not JSON-centric.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'serialism'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install serialism
+
+## Usage
+
+```ruby
+# A class you want to serialize instances of.
+class Foo
+  attr_accessor :id
+
+  def initialize(id)
+    @id = id
+  end
+end
+
+# A class describing how you want to serialize instances of Foo.
+class FooSerializer < Serialism::Serializer
+
+  # These properties will be present in each serialized record.
+  attributes :id, :computed
+
+  # Methods have access to the `Foo` instance they're working on via `object`.
+  def computed
+    "computed - #{object.id}"
+  end
+end
+
+items = [
+  Foo.new(1),
+  Foo.new(2),
+  Foo.new(3)
+]
+
+serializer = FooSerializer.new(items[0])
+serializer.render
+# => {:id=>1, :computed=>"computed - 1"}
+
+collection = Serialism::Collection.new(items, serializer: FooSerializer)
+
+puts collection.to_csv
+# id,computed
+# 1,computed - 1
+# 2,computed - 2
+# 3,computed - 3
+
+puts collection.to_json
+# [
+#   {
+#     "id": 1,
+#     "computed": "computed - 1"
+#   },
+#   {
+#     "id": 2,
+#     "computed": "computed - 2"
+#   },
+#   {
+#     "id": 3,
+#     "computed": "computed - 3"
+#   }
+# ]
+
+
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/serialism/collection.rb

@@ -0,0 +1,94 @@
+module Serialism
+
+  # Combines a set of items and a serializer class.
+  #
+  # Example:
+  #
+  #   class Foo
+  #     attr_accessor :id
+  #   end
+  #
+  #   class FooSerializer < Serialism::Serializer
+  #     attributes :id
+  #   end
+  #
+  #   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
+    #    A collection of items.
+    #    All member items should be encodable by `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"
+      end
+      if ! serializer.instance_methods.include?(:render)
+        raise ArgumentError, "serializer must implement an instance-level :render method"
+      end
+      @serializer = serializer
+
+      self.items = items
+    end
+
+    # Set the items in the collection.
+    #
+    # Replaces any previous items already in the collection.
+    #
+    # @param [#each] items an enumerable collection of items
+    # @return [CsvCollection]
+    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)
+
+      @items = items
+      self
+    end
+
+    # return the attributes for the collection
+    #
+    # @return [Array]
+    def attributes
+      return [] if items.size == 0
+
+      @serializer.attributes
+    end
+
+    # Generate a csv string for the collection
+    #
+    # When members of the array returned by the serializer are themselves arrays,
+    # these sub-arrays will be joined using "," prior to being added to the main
+    # CSV.
+    #
+    # @return [String]
+    def to_csv
+      require 'csv'
+
+      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
+        end
+      end
+    end
+
+    def to_json
+      require 'json'
+
+      JSON.dump(items.map {|t| @serializer.new(t).render })
+    end
+
+  end
+end

data/lib/serialism/serializer.rb

@@ -0,0 +1,59 @@
+module Serialism
+
+  # Base class for concrete serializers to inherit from.
+  #
+  # Example:
+  #
+  #   class Foo
+  #     attr_accessor :id
+  #   end
+  #
+  #   class FooSerializer < Serialism::Serializer
+  #     attributes :id, :computed
+  #
+  #     def computed
+  #       "computed - #{object.id}"
+  #     end
+  #   end
+  #
+  #   item = Foo.new
+  #   item.id = 12
+  #
+  #   serializer = FooSerializer.new(item)
+  #   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
+    end
+
+    def initialize(object)
+      @object = object
+    end
+
+    # Transform `object` using rules defined by the serializer.
+    #
+    # @return [Hash] Keys are defined by the classes `attributes`.
+    def render
+      self.class.attributes.inject({}) do |memo,attr|
+        if respond_to?(attr)
+          memo[attr] = self.send(attr)
+        elsif object.respond_to?(attr)
+          memo[attr] = object.send(attr)
+        else
+          raise ArgumentError, "Unknown attribute :#{attr}"
+        end
+        memo
+      end
+    end
+
+  end
+
+end

data/lib/serialism/version.rb

@@ -0,0 +1,3 @@
+module Serialism
+  VERSION = "0.0.1"
+end

data/lib/serialism.rb

@@ -0,0 +1,6 @@
+require "serialism/version"
+require "serialism/collection"
+require "serialism/serializer"
+
+module Serialism
+end

data/serialism.gemspec

@@ -0,0 +1,27 @@
+# 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.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.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"
+
+end

data/spec/lib/serialism/collection_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+RSpec.describe Serialism::Collection, type: :model do
+
+  # a serializer class
+  let(:serializer) do
+    Class.new(Serialism::Serializer) do
+      attributes :id, :computed
+
+      def computed
+        "computed - #{object.id}"
+      end
+    end
+  end
+
+  # a class being serialized
+  let(:serialized) do
+    Struct.new(:id)
+  end
+
+  let(:items) do
+    3.times.map do |i|
+      serialized.new(i)
+    end
+  end
+
+  let(:collection) do
+    Serialism::Collection.new(items, serializer: serializer)
+  end
+
+  describe 'initialize' do
+    it 'should require serializer to implement class-level attributes' do
+      invalid_serializer = Class.new
+
+      expect {
+        Serialism::Collection.new([], serializer: invalid_serializer)
+      }.to raise_error(ArgumentError, 'serializer must implement a class-level :attributes method')
+    end
+
+    it 'should require serializer to implement instance-level render' do
+      invalid_serializer = Class.new do
+        def self.attributes
+        end
+      end
+
+      expect {
+        Serialism::Collection.new([], serializer: invalid_serializer)
+      }.to raise_error(ArgumentError, 'serializer must implement an instance-level :render method')
+    end
+
+    it 'should succeed when given a valid serializer' do
+      serializer = Class.new do
+        def self.attributes
+        end
+
+        def render
+        end
+      end
+
+      expect {
+        Serialism::Collection.new([], serializer: serializer)
+      }.not_to raise_error
+    end
+  end
+
+  describe 'items=' do
+    it 'should require argument to respond_to :each' do
+      expect {
+        collection.items = :blat
+      }.to raise_error(ArgumentError, 'argument must respond_to :each')
+    end
+  end
+
+  describe 'attributes' do
+    it 'should return array of attributes' do
+      expect(collection.attributes).to eq serializer.attributes
+    end
+  end
+
+  describe 'to_csv' do
+    it 'should generate a csv string' do
+
+      expected = <<-EOF
+id,computed
+0,computed - 0
+1,computed - 1
+2,computed - 2
+EOF
+      expect(collection.to_csv).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 = <<-EOF
+id,computed
+"1,2,3","computed - [1, 2, 3]"
+"4,5,6","computed - [4, 5, 6]"
+EOF
+      expect(collection.to_csv).to eq expected
+    end
+  end
+
+  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"}]'
+    end
+  end
+
+end

data/spec/lib/serialism/serializer_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+RSpec.describe Serialism::Serializer, type: :model do
+
+  let(:subject) do
+    Class.new(Serialism::Serializer) do
+      attributes :id, :computed
+
+      def computed
+        "computed by serializer - #{object.id}"
+      end
+    end
+  end
+
+  describe '.attributes' do
+    it 'should allow attributes to be set and retrieved' do
+      subject.attributes(:a, :b)
+
+      expect(subject.attributes).to eq([:a, :b])
+    end
+  end
+
+  describe '#render' do
+    let(:item) do
+      item_class = Struct.new(:id, :computed)
+      item_class.new(1, "'computed' defined in item")
+    end
+
+    it 'should prefer attribute implementations in the serializer' do
+      values = subject.new(item).render
+      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
+      values = subject.new(item).render
+      expect(values[:id]).to eq 1
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,63 @@
+require_relative '../lib/serialism'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: serialism
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Dean
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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: ruby_gntp
+  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: ci_reporter_rspec
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/serialism.rb
+- lib/serialism/collection.rb
+- lib/serialism/serializer.rb
+- lib/serialism/version.rb
+- serialism.gemspec
+- spec/lib/serialism/collection_spec.rb
+- spec/lib/serialism/serializer_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Like ActiveModel::Serializer but smaller and not JSON-centric.
+test_files:
+- spec/lib/serialism/collection_spec.rb
+- spec/lib/serialism/serializer_spec.rb
+- spec/spec_helper.rb