csv_plus_plus 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66b51b9e9784f89236625da57b647867b502b50acad209d1e98619fd94fb6f70
-  data.tar.gz: f4815f9a10637ee82a4f4f1e32afbd9db47bf728eb3992bb77ce75d9fb460092
+  metadata.gz: ea5b029c524b401348cc42399514c9fb689b13bfcf7298664429f69c85ae6607
+  data.tar.gz: 5bb79395742dcd89bf3b4ca7ede92a9a41a2c3ddefc4dff1b4232c285117373d
 SHA512:
-  metadata.gz: 5a983659e3033642f9ff185adca67897a3510578ef765f1cc4f65e8df6ec1f1ecf8b767e6860c3af00c773b6b5d4229bc4699e071a38b04a3f31ec55a225cf76
-  data.tar.gz: '0684df3fc8678b6061d572da196bcdfb24f224009c9fa61b64b769178aa18dd6697c7a9f4dba3ab93e15b3a79ecfcd350f23abf1c117bee9026a0b9ba47e6e6c'
+  metadata.gz: 4a1bf4ccf98486b64ed69f34e701e9c4c69aea2b971c569aab7f6345ca721ccbde01570449033be23eeea37ec59d244dbb2692f27bfbfaae6069c84e23ea988a
+  data.tar.gz: 8cef1aa204255588787b3e3138ec282a9b45c174b83e647a91d0476aca199ee4ee8640f11c40418cded6026016a4383e1e1df7600cdfa5c5524d25a6c953fb76

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## v0.0.4
+
+- Excel support
+
+## v0.0.3
+
+- Fix the gem package to include the bin/ file
+
+## v0.0.2
+
+- First publish to rubygems.org

data/README.md

@@ -0,0 +1,103 @@
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-community-brightgreen.svg)](https://rubystyle.guide)
+
+# csv++
+
+A tool that allows you to programatically author spreadsheets in your favorite text editor and write their results to CSV, Google Sheets, Excel and other spreadsheet formats.  This allows you to write a spreadsheet template, check it into git and push changes out to spreadsheets using typical dev tools.
+
+## Template Language
+
+A `csvpp` file consists of a (optional) code section and a CSV section separated by `---`.  In the code section you can define variables and functions that can be used in the CSV below it.  For example:
+
+```
+fees := 0.50 # my broker charges $0.50 a trade
+
+price := cellref(C)
+quantity := cellref(D)
+
+def profit() (price * quantity) - fees
+
+---
+![[format=bold/align=center]]Date,Ticker,Price,Quantity,Total,Fees
+![[expand]],[[format=bold]],,,"=PROFIT()",$$fees
+```
+
+## Predefined Variables
+
+* `$$rownum` - The current row number.  The first row of the spreadsheet starts at 1
+
+## Predefined Functions
+
+* `cellref(CELL)` - Returns a reference to the `CELL` relative to the current row.  If the current `$$rownum` is `2`, then `CELLREF("C")` returns  a reference to cell `C2`.
+
+## Modifiers
+
+Modifiers can change the formatting of a cell or row, apply validation, change alignment, etc. All of the normal rules of CSV apply, with the addition that each cell can have modifiers (specified in `[[`/`]]` for cells and `![[`/`]]` for rows):
+
+```
+foo,[[...]]bar,baz
+```
+
+specifying formatting or various other modifiers to the cell.  Additionally a row can start with:
+
+```
+![[...]]foo,bar,baz
+```
+
+which will apply that modifier to all cells in the row.
+
+### Examples
+
+* Align the second cell left, align the last cell to the center and make it bold and italicized:
+
+```
+Date,[[align=left]]Amount,Quantity,[[align=center/format=bold italic]]Price
+```
+
+* Underline and center-align an entire row:
+
+```
+![[align=center/format=underline]]Date,Amount,Quantity,Price
+```
+
+* A header for the first row, then some formulas that repeat for each row for the rest of the spreadsheet:
+
+```
+![[align=center/format=bold]]Date,Price,Quantity,Profit
+![[expand=1:]],,,"=MULTIPLY(cellref(B), cellref(C))"
+```
+
+## Setup (Google Sheets)
+
+Just install it via rubygems (homebrew and debian packages are in the works):
+
+`$ gem install csv_plus_plus`
+
+### Publishing to Google Sheets
+
+* Go to the [GCP developers console](https://console.cloud.google.com/projectselector2/apis/credentials?pli=1&supportedpurview=project), create a service account and export keys for it to `~/.config/gcloud/application_default_credentials.json`
+* "Share" the spreadsheet with the email associated with the service account
+
+## CLI Arguments
+
+```
+Usage: csv++ [options]
+    -b, --backup                     Create a backup of the spreadsheet before applying changes.
+    -g, --google-sheet-id SHEET_ID   The id of the sheet - you can extract this from the URL: https://docs.google.com/spreadsheets/d/< ... SHEET_ID ... >/edit#gid=0
+    -c, --create                     Create the sheet if it doesn't exist.  It will use --sheet-name if specified
+    -k, --key-values KEY_VALUES      A comma-separated list of key=values which will be made available to the template
+    -n, --sheet-name SHEET_NAME      The name of the sheet to apply the template to
+    -v, --verbose                    Enable verbose output
+    -x, --offset-columns OFFSET      Apply the template offset by OFFSET cells
+    -y, --offset-rows OFFSET         Apply the template offset by OFFSET rows
+    -h, --help                       Show help information
+```
+
+## Usage Examples
+
+```
+# apply my_taxes_template.csvpp to an existing Google Sheet with name "Taxes 2022"
+$ csv++ --sheet-name "Taxes 2022" --sheet-id "[...]" my_taxes_template.csvpp
+
+# take input from stdin, supply a variable ($$rate = 1) and apply to the "Stocks" spreadsheet
+$ cat stocks.csvpp | csv++ -k "rate=1" -n "Stocks" -i "[...]"
+```

data/bin/csv++

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require_relative '../lib/csv_plus_plus'
+
+options = ::CSVPlusPlus::Options.new
+
+option_parser =
+  ::OptionParser.new do |parser|
+    parser.on('-h', '--help', 'Show help information') do
+      puts(parser)
+      exit
+    end
+
+    ::SUPPORTED_CSVPP_FLAGS.each do |flag|
+      parser.on(flag.short_flag, flag.long_flag, flag.description) do |v|
+        flag.handler.call(options, v)
+      end
+    end
+  end
+
+option_parser.parse!
+
+error_message = options.validate
+unless error_message.nil?
+  warn(error_message)
+  puts(option_parser)
+  exit(1)
+end
+
+begin
+  ::CSVPlusPlus.apply_template_to_sheet!(::ARGF.read, ::ARGF.filename, options)
+rescue ::CSVPlusPlus::Error => e
+  if e.is_a?(::CSVPlusPlus::Language::SyntaxError)
+    warn(options.verbose ? e.to_verbose_trace : e.to_trace)
+  else
+    warn(e.message)
+  end
+
+  exit(1)
+end

data/lib/csv_plus_plus/cli_flag.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative './google_options'
+
+module CSVPlusPlus
+  # Individual CLI flags that a user can supply
+  class CliFlag
+    attr_reader :short_flag, :long_flag, :description, :handler
+
+    # initialize
+    def initialize(short_flag, long_flag, description, handler)
+      @short_flag = short_flag
+      @long_flag = long_flag
+      @description = description
+      @handler = handler
+    end
+
+    # to_s
+    def to_s
+      "#{@short_flag}, #{@long_flag}  #{@description}"
+    end
+  end
+end
+
+SUPPORTED_CSVPP_FLAGS = [
+  ::CSVPlusPlus::CliFlag.new(
+    '-b',
+    '--backup',
+    'Create a backup of the spreadsheet before applying changes.',
+    ->(options, _v) { options.backup = true }
+  ),
+  ::CSVPlusPlus::CliFlag.new(
+    '-c',
+    '--create',
+    "Create the sheet if it doesn't exist.  It will use --sheet-name if specified",
+    ->(options, _v) { options.create_if_not_exists = true }
+  ),
+  ::CSVPlusPlus::CliFlag.new(
+    '-g SHEET_ID',
+    '--google-sheet-id SHEET_ID',
+    'The id of the sheet - you can extract this from the URL: ' \
+    'https://docs.google.com/spreadsheets/d/< ... SHEET_ID ... >/edit#gid=0',
+    ->(options, v) { options.google_sheet_id = v }
+  ),
+  ::CSVPlusPlus::CliFlag.new(
+    '-k',
+    '--key-values KEY_VALUES',
+    'A comma-separated list of key=values which will be made available to the template',
+    lambda do |options, v|
+      options.key_values =
+        begin
+          [v.split('=')].to_h
+        rescue ::StandardError
+          {}
+        end
+    end
+  ),
+  ::CSVPlusPlus::CliFlag.new(
+    '-n SHEET_NAME',
+    '--sheet-name SHEET_NAME',
+    'The name of the sheet to apply the template to',
+    ->(options, v) { options.sheet_name = v }
+  ),
+  ::CSVPlusPlus::CliFlag.new(
+    '-o OUTPUT_FILE',
+    '--output OUTPUT_FILE',
+    'The file to write to (must be .csv, .ods, .xls)',
+    ->(options, v) { options.output_filename = v }
+  ),
+  ::CSVPlusPlus::CliFlag.new('-v', '--verbose', 'Enable verbose output', ->(options, _v) { options.verbose = true }),
+  ::CSVPlusPlus::CliFlag.new(
+    '-x OFFSET',
+    '--offset-columns OFFSET',
+    'Apply the template offset by OFFSET cells',
+    ->(options, v) { options.offset[0] = v }
+  ),
+  ::CSVPlusPlus::CliFlag.new(
+    '-y OFFSET',
+    '--offset-rows OFFSET',
+    'Apply the template offset by OFFSET rows',
+    ->(options, v) { options.offset[1] = v }
+  )
+].freeze

data/lib/csv_plus_plus/color.rb

@@ -3,20 +3,54 @@
 module CSVPlusPlus
   # A color value
   class Color
-    attr_reader :red, :green, :blue
+    attr_reader :red_hex, :green_hex, :blue_hex
 
     # create an instance from a string like "#FFF" or "#FFFFFF"
     def initialize(hex_string)
-      @red, @green, @blue =
-        hex_string
-        .gsub(/^#?/, '')
-        .match(/(\w\w?)(\w\w?)(\w\w?)/)
-        .captures
-        .map do |s|
-          255 / (s.length == 2 ? s : s + s).to_i(16)
-        rescue ::StandardError
-          0
-        end
+      @red_hex, @green_hex, @blue_hex = hex_string
+                                        .gsub(/^#?/, '')
+                                        .match(/([0-9a-f]{1,2})([0-9a-f]{1,2})([0-9a-f]{1,2})/i)
+                                        &.captures
+                                        &.map { |s| s.length == 1 ? s + s : s }
+    end
+
+    # The percent (decimal between 0-1) of red
+    def red_percent
+      hex_to_percent(@red_hex)
+    end
+
+    # The percent (decimal between 0-1) of green
+    def green_percent
+      hex_to_percent(@green_hex)
+    end
+
+    # The percent (decimal between 0-1) of blue
+    def blue_percent
+      hex_to_percent(@blue_hex)
+    end
+
+    # to_hex
+    def to_hex
+      [@red_hex, @green_hex, @blue_hex].join
+    end
+
+    # to_s
+    def to_s
+      "Color(r: #{@red_hex}, g: #{@green_hex}, b: #{@blue_hex})"
+    end
+
+    # ==
+    def ==(other)
+      other.is_a?(self.class) &&
+        other.red_hex == @red_hex &&
+        other.green_hex == @green_hex &&
+        other.blue_hex == @blue_hex
+    end
+
+    private
+
+    def hex_to_percent(hex)
+      hex.to_i(16) / 255
     end
   end
 end

data/lib/csv_plus_plus/error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module CSVPlusPlus
+  # An error thrown by our code (generally to be handled at the top level bin/ command)
+  class Error < StandardError
+  end
+end

data/lib/csv_plus_plus/graph.rb

@@ -54,11 +54,6 @@ module CSVPlusPlus
       include ::TSort
       alias tsort_each_node each_key
 
-      # create a +DependencyGraph+ from a +Hash+
-      def self.from_hash(hash)
-        self[hash.map { |k, v| [k, v] }]
-      end
-
       # sort each child
       def tsort_each_child(node, &)
         fetch(node).each(&)

data/lib/csv_plus_plus/language/compiler.rb

@@ -14,7 +14,6 @@ require_relative 'scope'
 
 module CSVPlusPlus
   module Language
-    ##
     # Encapsulates the parsing and building of objects (+Template+ -> +Row+ -> +Cell+).
     # Variable resolution is delegated to the +Scope+
     # rubocop:disable Metrics/ClassLength

data/lib/csv_plus_plus/language/scope.rb

@@ -127,8 +127,6 @@ module CSVPlusPlus
 
         # this will throw a syntax error if it doesn't exist (which is what we want)
         return ::BUILTIN_FUNCTIONS[id] if ::BUILTIN_FUNCTIONS.key?(id)
-
-        @runtime.raise_syntax_error('Unknown function', fn_id)
       end
 
       def apply_arguments(function, function_call)

data/lib/csv_plus_plus/language/syntax_error.rb

@@ -4,7 +4,7 @@ module CSVPlusPlus
   module Language
     ##
     # An error that can be thrown for various syntax errors
-    class SyntaxError < StandardError
+    class SyntaxError < ::CSVPlusPlus::Error
       # initialize
       def initialize(message, bad_input, runtime, wrapped_error: nil)
         @bad_input = bad_input.to_s

data/lib/csv_plus_plus/modifier.rb

@@ -6,32 +6,20 @@ require_relative './expand'
 require_relative './language/syntax_error'
 
 module CSVPlusPlus
-  ##
   # A container representing the operations that can be applied to a cell or row
   class Modifier
     attr_reader :bordercolor, :borders, :color, :fontcolor, :formats
     attr_writer :borderstyle
-    attr_accessor :expand, :fontfamily, :fontsize, :note, :numberformat, :row_level, :validation
+    attr_accessor :expand, :fontfamily, :fontsize, :halign, :valign, :note, :numberformat, :row_level, :validation
 
     # initialize
     def initialize(row_level: false)
       @row_level = row_level
       @freeze = false
-      @align = ::Set.new
       @borders = ::Set.new
       @formats = ::Set.new
     end
 
-    # Set an align format. +direction+ must be 'center', 'left', 'right', 'bottom'
-    def align=(direction)
-      @align << direction
-    end
-
-    # Is it aligned to a given direction?
-    def aligned?(direction)
-      @align.include?(direction)
-    end
-
     # Set the color.  hex_value is a String
     def color=(hex_value)
       @color = ::CSVPlusPlus::Color.new(hex_value)
@@ -110,12 +98,13 @@ module CSVPlusPlus
     # to_s
     def to_s
       # TODO... I dunno, not sure how to manage this
-      "Modifier(row_level: #{@row_level} align: #{@align} format: #{@formats} font_size: #{@font_size})"
+      "Modifier(row_level: #{@row_level} halign: #{@halign} valign: #{@valign} format: #{@formats} " \
+        "font_size: #{@font_size})"
     end
 
     # Create a new modifier instance, with all values defaulted from +other+
     def take_defaults_from!(other)
-      instance_variables.each do |property|
+      other.instance_variables.each do |property|
         value = other.instance_variable_get(property)
         instance_variable_set(property, value.clone)
       end