csv_blueprints 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5e8bed90e0ed20e6d0af5e2679335742d3b1be6b444efcb8922264ccf25224b1
+  data.tar.gz: a70c04fd366e675cb2292fe7bb9628160e33e0d970104d70460197dab72cff95
+SHA512:
+  metadata.gz: d1789c1526bbac517fb7de815d41b9797a837389f1103f163d72abf719eb18d53f856d2347a13541d992b12517db30d08cc767dbcac69f027fa0fcb08a5b6ae2
+  data.tar.gz: a94f9fb2758f6cc5e36d860b82310e2e154b68a408e02262b47e068bf0631ea57993f3cf5e0f511d4a45ee079e9a57dff54bd3d941fdbba64ef1b90195c890f4

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+coverage
+
+# rspec failure tracking
+.rspec_status
+
+# Gems should not include the lock file -- dependency versions are handled by the gemspec
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+sudo: false
+before_install: gem install bundler -v 1.17.3
+cache: bundler
+
+language: ruby
+rvm:
+  - 2.4.5
+  - 2.5.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in csv_blueprints.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jason Schweier
+
+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,87 @@
+# CSV Blueprints
+
+[![Build Status](https://travis-ci.com/jmks/csv_blueprints.svg?branch=master)](https://travis-ci.com/jmks/csv_blueprints)
+
+A simple and small DSL to generate CSV files.
+
+## Usage
+
+Declaratively specify a CSV blueprint:
+
+```ruby
+require "csv_blueprints"
+require "faker"
+
+blueprint = CsvBlueprints.specify do
+  column "ID", value: :sequence
+  column "Name", value: -> i { Faker::Name.name }
+  columns "Login", "Email", value: -> i { "email#{i}@example.com" }
+  column "Type", static: "Client"
+  column "Notes", value: :blank
+end
+```
+
+> We're using the [faker](https://github.com/stympy/faker) gem here for realistic names
+
+This one blueprint can generate multiple plans. E.g. differing numbers of rows or to override the row's values:
+
+```ruby
+# three rows
+plan = blueprint.plan.standard(3)
+plan.write
+```
+
+will generate a CSV like:
+
+```
+ID,Name,Login,Email,Type,Notes
+1,Val Kulas DVM,email1@example.com,email1@example.com,Client,
+2,Marsha Sporer,email2@example.com,email2@example.com,Client,
+3,Mrs. Bennett Bechtelar,email3@example.com,email3@example.com,Client,
+```
+
+Another plan from the same blueprint
+
+```ruby
+# two rows with duplicate IDs and a note
+plan_with_duplicate_ids = blueprint.plan.customized(2, "ID" => 999, "Notes" => "Imported on #{Date.today.strftime('%Y-%m-%d')}")
+plan_with_duplicate_ids.write
+```
+
+would generate
+
+```
+ID,Name,Login,Email,Type,Notes
+999,Tiffanie Schaden,email1@example.com,email1@example.com,Client,Imported on 2019-03-04
+999,Mr. Arie Stroman,email2@example.com,email2@example.com,Client,Imported on 2019-03-04
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "csv_blueprints"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install csv_blueprints
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jmks/csv_blueprints.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "csv_blueprints"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/install_local

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem uninstall --all csv_blueprints
+gem build csv_blueprints.gemspec
+find . -name csv_blueprints*.gem -exec gem install {} \;

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/csv_blueprints.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "csv_blueprints/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "csv_blueprints"
+  spec.version       = CsvBlueprints::VERSION
+  spec.authors       = ["Jason Schweier"]
+  spec.email         = ["jason.schweier@gmail.com"]
+
+  spec.summary       = %q{A declarative way to generate CSVs}
+  spec.description   = %q{Declaratively specify a CSV blueprint, then create customized plans for CSV generation.}
+  spec.homepage      = "https://github.com/jmks/csv_blueprints"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "simplecov", "~> 0.16"
+end

data/lib/csv_blueprints.rb

@@ -0,0 +1,14 @@
+require "csv_blueprints/plan"
+require "csv_blueprints/plan_writer"
+require "csv_blueprints/plan_builder"
+require "csv_blueprints/blueprint"
+
+require "csv_blueprints/version"
+
+module CsvBlueprints
+  def self.specify(&block)
+    Blueprint.new.tap do |blueprint|
+      blueprint.instance_eval(&block) if block_given?
+    end
+  end
+end

data/lib/csv_blueprints/blueprint.rb

@@ -0,0 +1,84 @@
+module CsvBlueprints
+  Column = Struct.new(:name, :value) do
+    def value_for(i)
+      if value.respond_to?(:call)
+        value.call(i)
+      else
+        value
+      end
+    end
+  end
+
+  class RepeatedValue
+    def initialize(callable, max_repetitions)
+      @callable = callable
+      @max_repetitions = max_repetitions
+      @repetitions = 0
+      @value = nil
+    end
+
+    def call(index)
+      calculate_value(index)
+      increment_repetitions
+      value
+    end
+
+    private
+
+    attr_reader :value
+
+    def calculate_value(index)
+      if @repetitions < @max_repetitions
+        @value ||= @callable.call(index)
+      else
+        @repetitions = 0
+        @value = @callable.call(index)
+      end
+    end
+
+    def increment_repetitions
+      @repetitions += 1
+    end
+  end
+
+  class Blueprint
+    def initialize
+      @columns = []
+    end
+
+    def column(name, value: nil)
+      @columns << column_for_value(name, value)
+    end
+
+    def columns(*names, value:)
+      wrapped_value = value.respond_to?(:call) ? RepeatedValue.new(value, names.length) : value
+
+      names.each { |name| column(name, value: wrapped_value) }
+    end
+
+    def plan
+      PlanBuilder.new(self)
+    end
+
+    def column_names
+      @columns.map(&:name)
+    end
+
+    def default_values(row)
+      Hash[@columns.map { |c| [c.name, c.value_for(row)] }]
+    end
+
+    private
+
+    def column_for_value(name, value)
+      case value
+      when :blank
+        Column.new(name, nil)
+      when :sequence
+        Column.new(name, -> i { i })
+      else
+        Column.new(name, value)
+      end
+    end
+  end
+end

data/lib/csv_blueprints/plan.rb

@@ -0,0 +1,50 @@
+module CsvBlueprints
+  class Plan
+    class StandardRow
+      def values_for(index, blueprint)
+        blueprint.default_values(index)
+      end
+    end
+
+    class CustomizedRow < StandardRow
+      def initialize(overrides)
+        @overrides = overrides
+      end
+
+      def values_for(index, blueprint)
+        values = super
+
+        @overrides.each_pair do |column, value|
+          if values.key?(column)
+            values[column] = value
+          end
+        end
+
+        values
+      end
+    end
+
+    def initialize(blueprint)
+      @blueprint = blueprint
+      @rows = []
+    end
+
+    def add_row(overrides = {})
+      if overrides.any?
+        @rows << CustomizedRow.new(overrides)
+      else
+        @rows << StandardRow.new
+      end
+    end
+
+    def column_names
+      @blueprint.column_names
+    end
+
+    def each_row
+      @rows.each.with_index do |row, index|
+        yield row.values_for(index + 1, @blueprint)
+      end
+    end
+  end
+end

data/lib/csv_blueprints/plan_builder.rb

@@ -0,0 +1,22 @@
+module CsvBlueprints
+  class PlanBuilder
+    def initialize(blueprint)
+      @blueprint = blueprint
+      @plan = Plan.new(@blueprint)
+    end
+
+    def standard(number)
+      number.times { @plan.add_row }
+      self
+    end
+
+    def customized(number, overrides)
+      number.times { @plan.add_row(overrides) }
+      self
+    end
+
+    def write(out = STDOUT)
+      PlanWriter.new(@plan).write(out)
+    end
+  end
+end

data/lib/csv_blueprints/plan_writer.rb

@@ -0,0 +1,17 @@
+require "csv"
+
+module CsvBlueprints
+  class PlanWriter
+    def initialize(plan)
+      @plan = plan
+    end
+
+    def write(out)
+      csv = CSV.new(out, headers: @plan.column_names, write_headers: true)
+
+      @plan.each_row { |row| csv << row }
+
+      csv
+    end
+  end
+end

data/lib/csv_blueprints/version.rb

@@ -0,0 +1,3 @@
+module CsvBlueprints
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: csv_blueprints
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Schweier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: Declaratively specify a CSV blueprint, then create customized plans for
+  CSV generation.
+email:
+- jason.schweier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/install_local
+- bin/setup
+- csv_blueprints.gemspec
+- lib/csv_blueprints.rb
+- lib/csv_blueprints/blueprint.rb
+- lib/csv_blueprints/plan.rb
+- lib/csv_blueprints/plan_builder.rb
+- lib/csv_blueprints/plan_writer.rb
+- lib/csv_blueprints/version.rb
+homepage: https://github.com/jmks/csv_blueprints
+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.7.6
+signing_key: 
+specification_version: 4
+summary: A declarative way to generate CSVs
+test_files: []