portable 1.0.0.pre.alpha.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9a80aeca8e54c0e02bf414ee6c79b6e110e126a57fc64a3a9d3f8990481f940
-  data.tar.gz: 7ee0c481c4d15148857726d3644230a76a52f8ae178425c5e1c5defbc485c81b
+  metadata.gz: 563f9b0e89cfa8fecd2346faa4448a88919ee8188c08ddfbcb0dfe0033acf0b6
+  data.tar.gz: 3f3d82c6a9539e93028cf781b72bdd42d3bd753ccb0a6a2018286a3afc71e20f
 SHA512:
-  metadata.gz: 2e45f20154ff8471104bcdbd5fbbc32d8cf3c892606c077f418b3d29456c8221c080bc7ae2719f63920e54a8f139ad62b2104ecfee1a39699d54467134f6a9be
-  data.tar.gz: d11bdfc431b996f82b8f6b14f53862ff98236ad08f6c7e79d87fdd3153137c42bc71687506bf2bfa544a9c1a62e745ba9658a8e1ded37eba3e9e705cb173ed49
+  metadata.gz: 511a1e5ccea009b86e5c4f8838945c6d6cadf150709f5f31e6d6163b59431d05a0a2604ecc4686529f8aa505857f55607de4a74510348b20d52c71ec23b559af
+  data.tar.gz: 93c0c1a1480d961fedfe4c46a909b0ecb25958bfcfb55c8dd0575d7318c7575176b0347588c543d1830b22938a22a473283ce78a109378d9926f423a0848c41b

data/CHANGELOG.md

@@ -1,3 +1,3 @@
-# 1.0.0 (TBD)
+# 1.0.0 (August 25th, 2020)
 
 Initial implementation.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at oss@bluemarblepayroll.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/README.md

@@ -35,7 +35,7 @@ patients = [
 data_provider = Portable::Data::Provider.new(
   data_sources: {
     data_rows: patients,
-    fields: %i[first last dob]
+    keys: %i[first last dob]
   }
 )
 ````
@@ -50,7 +50,7 @@ document = nil # or {} or Portable::Document.new
 
 The above document says I would like a document with one sheet, and since I did not provide a data_table specification, I would like all the fields emitted from the data source.
 
-Combining a document + writer + data provider yields a set of documents (it may be more than one if the writer does not know how to write intra-file sheets, i.e. CSV files.)
+Combining a document + writer + data provider yields a set of documents.  It may emit more than one file if the writer does not know how to write intra-file sheets (i.e. CSV files).
 
 ````ruby
 writer    = Portable::Writers::Csv.new(document)
@@ -72,6 +72,18 @@ This library uses Realize under the hood, so you have the option of configuring
 Let's expand our CSV example above with different headers and date formatting:
 
 ````ruby
+patients = [
+  { first: 'Marky', last: 'Mark', dob: '2000-04-05' },
+  { first: 'Frank', last: 'Rizzo', dob: '1930-09-22' }
+]
+
+data_provider = Portable::Data::Provider.new(
+  data_sources: {
+    data_rows: patients,
+    keys: %i[first last dob]
+  }
+)
+
 document = {
   sheets: [
     {
@@ -101,14 +113,20 @@ document = {
     }
   ]
 }
+
+writer    = Portable::Writers::Csv.new(document)
+name      = File.join('tmp', 'patients.csv')
+written   = writer.write!(filename: name, data_provider: data_provider)
 ````
 
 Executing it the same way would now yield a different CSV file:
 
+````
 First Name | Last Name | Date of Birth
 ---------- | --------- | -------------
 Marky      | Mark      | 04/05/2000
 Frank      | Rizzo     | 09/22/1930
+````
 
 Realize is also [pluggable](https://github.com/bluemarblepayroll/realize#plugging-in-transformers), so you are able to create your own and plug them directly into Realize.
 
@@ -120,7 +138,7 @@ Each writer can choose how and which options to support.
 
 The following options are available for customizing CSV documents:
 
-* byte_order_mark: (optional, default is nothing): This option will write out a byte order mark identifying the encoding for the file.  This is useful for ensuring applications like Microsoft Excel open CSV files properly.  See Portable::Modeling::ByteOrderMark constants for acceptable values.
+* byte_order_mark: (optional, default is nothing): This option will write out a [byte order mark](https://en.wikipedia.org/wiki/Byte_order_mark) identifying the endianess for the file.  This is useful for ensuring applications like Microsoft Excel open CSV files properly.  See Portable::Modeling::ByteOrderMark constants for acceptable values.
 
 ### Static Header/Footer Rows
 
@@ -135,7 +153,7 @@ patients = [
 data_provider = Portable::Data::Provider.new(
   data_sources: {
     data_rows: patients,
-    fields: %i[first last dob],
+    keys: %i[first last dob],
     header_rows: [
       %w[FIRST_START LAST_START DOB_START]
     ],
@@ -160,6 +178,10 @@ document = {
     }
   ]
 }
+
+writer    = Portable::Writers::Csv.new(document)
+name      = File.join('tmp', 'patients.csv')
+written   = writer.write!(filename: name, data_provider: data_provider)
 ````
 
 Using this document configuration would yield a CSV with four "header rows" at the top, one "data table header row", two data rows, and one "footer row".  This is not easily illustrated in Markdown, but this would be the result:
@@ -169,10 +191,12 @@ Run Date   | 04/05/2000
 Run By     | Hops the Bunny
 
 BEGIN
-First Name | Last Name | Date of Birth
----------- | --------- | -------------
-Marky      | Mark      | 04/05/2000
-Frank      | Rizzo     | 09/22/1930
+FIRST_START | LAST_START | DOB_START
+first       | last       | dob
+----------- | ---------- | -------------
+Marky       | Mark       | 2000-04-05
+Frank       | Rizzo      | 1930-09-22
+FIRST_END   | LAST_END   | DOB_END
 END
 ````
 

data/lib/portable/data/source.rb

@@ -19,17 +19,17 @@ module Portable
       attr_reader :header_rows,
                   :footer_rows,
                   :data_rows,
-                  :fields,
+                  :keys,
                   :name
 
       # Individial header and footer rows are arrays, while individual data_rows is an object
       # like a hash, Struct, OpenStruct, or really any PORO.
-      def initialize(name: '', header_rows: [], footer_rows: [], data_rows: [], fields: [])
+      def initialize(name: '', header_rows: [], footer_rows: [], data_rows: [], keys: [])
         @name        = name.to_s
         @header_rows = header_rows || []
         @footer_rows = footer_rows || []
         @data_rows   = data_rows   || []
-        @fields      = fields      || []
+        @keys        = keys        || []
 
         freeze
       end

data/lib/portable/modeling/sheet.rb

@@ -46,6 +46,8 @@ module Portable
         freeze
       end
 
+      private
+
       # Use exact name if possible, if not then use the sheet name or else use the
       # "default" one (noted by a blank name).
       def decide_data_source_name(data_source_name, sheet_name)

data/lib/portable/rendering/sheet.rb

@@ -27,26 +27,26 @@ module Portable
         freeze
       end
 
-      def row_renderer(sheet_name, fields)
+      def row_renderer(sheet_name, keys)
         sheet        = document.sheet(sheet_name)
         row_renderer = row_renderers.fetch(sheet_name.to_s)
 
         return row_renderer unless sheet.auto?
 
-        dynamic_row_renderer(fields).merge(row_renderer)
+        dynamic_row_renderer(keys).merge(row_renderer)
       end
 
       private
 
       attr_reader :row_renderers
 
-      def fields_to_columns(fields)
-        fields = (fields || []).map { |f| { header: f.to_s } }
-        Modeling::Column.array(fields)
+      def fields_to_columns(keys)
+        key_objects = (keys || []).map { |f| { header: f.to_s } }
+        Modeling::Column.array(key_objects)
       end
 
-      def dynamic_row_renderer(fields)
-        Row.new(fields_to_columns(fields), resolver: resolver)
+      def dynamic_row_renderer(keys)
+        Row.new(fields_to_columns(keys), resolver: resolver)
       end
     end
   end

data/lib/portable/util/uniqueness.rb

@@ -18,7 +18,7 @@ module Portable
 
         return if names.uniq.length == array.length
 
-        raise DuplicateNameError, "cannot contain duplicate names: #{names}"
+        raise DuplicateNameError, "cannot contain duplicate names (case insensitive): #{names}"
       end
     end
   end

data/lib/portable/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Portable
-  VERSION = '1.0.0-alpha.7'
+  VERSION = '1.0.0'
 end

data/lib/portable/writers/csv.rb

@@ -52,7 +52,7 @@ module Portable
       end
 
       def write_data_table(csv, sheet, data_source, time)
-        row_renderer = sheet_renderer.row_renderer(sheet.name, data_source.fields)
+        row_renderer = sheet_renderer.row_renderer(sheet.name, data_source.keys)
 
         csv << row_renderer.headers if sheet.include_headers?
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: portable
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-10 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -165,6 +165,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
 - LICENSE
@@ -215,9 +216,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: