csv_plus_plus 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11364af3824cbfff63df10d7b932a6ad2c7a222e1a40b39f151af82a150d5dc4
-  data.tar.gz: 2d6fe31ae0e6a7dee0c19f31b0328e1b20973541c6e2c12cb64f3fbf96d8fa02
+  metadata.gz: ea5b029c524b401348cc42399514c9fb689b13bfcf7298664429f69c85ae6607
+  data.tar.gz: 5bb79395742dcd89bf3b4ca7ede92a9a41a2c3ddefc4dff1b4232c285117373d
 SHA512:
-  metadata.gz: 623953f6ff728e1dfc1f7f329dbc89e5ae7b7687cebd6da387ea36f0b0659020142e5f2029533e46964b8bf51c2f78b79634b9bb346cad6e6c96ae69d6737fb1
-  data.tar.gz: 0604bc094e8d287bcec1390ff884786fe8dbf12b5e6e4ec4785cc9cef2297f92360a9a60809c855630edd5f633b2bc16bf378cb0c47a1be7eb2a7f70ae6beb7a
+  metadata.gz: 4a1bf4ccf98486b64ed69f34e701e9c4c69aea2b971c569aab7f6345ca721ccbde01570449033be23eeea37ec59d244dbb2692f27bfbfaae6069c84e23ea988a
+  data.tar.gz: 8cef1aa204255588787b3e3138ec282a9b45c174b83e647a91d0476aca199ee4ee8640f11c40418cded6026016a4383e1e1df7600cdfa5c5524d25a6c953fb76

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.0.4
+
+- Excel support
+
 ## v0.0.3
 
 - Fix the gem package to include the bin/ file

data/README.md

@@ -9,7 +9,7 @@ A tool that allows you to programatically author spreadsheets in your favorite t
 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.65 # my broker charges $0.65 a trade
+fees := 0.50 # my broker charges $0.50 a trade
 
 price := cellref(C)
 quantity := cellref(D)

data/bin/csv++

@@ -7,64 +7,18 @@ require_relative '../lib/csv_plus_plus'
 options = ::CSVPlusPlus::Options.new
 
 option_parser =
-  # rubocop:disable Metrics/BlockLength
   ::OptionParser.new do |parser|
-    parser.on('-b', '--backup', 'Create a backup of the spreadsheet before applying changes.') do
-      options.backup = true
-    end
-
-    parser.on(
-      '-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'
-    ) do |v|
-      options.google_sheet_id = v
-    end
-
-    parser.on('-c', '--create', "Create the sheet if it doesn't exist.  It will use --sheet-name if specified") do
-      options.create_if_not_exists = true
-    end
-
-    parser.on(
-      '-k KEY_VALUES',
-      '--key-values KEY_VALUES',
-      'A comma-separated list of key=values which will be made available to the template'
-    ) do |v|
-      options.key_values =
-        begin
-          [v.split('=')].to_h
-        rescue ::StandardError
-          {}
-        end
-    end
-
-    parser.on('-n SHEET_NAME', '--sheet-name SHEET_NAME', 'The name of the sheet to apply the template to') do |v|
-      options.sheet_name = v
-    end
-
-    parser.on('-o OUTPUT_FILE', '--output OUTPUT_FILE', 'The file to write to (must be .csv, .ods, .xls)') do |v|
-      options.output_filename = v
-    end
-
-    parser.on('-v', '--verbose', 'Enable verbose output') do
-      options.verbose = true
-    end
-
-    parser.on('-x OFFSET', '--offset-columns OFFSET', 'Apply the template offset by OFFSET cells') do |v|
-      options.offset[0] = v
-    end
-
-    parser.on('-y OFFSET', '--offset-rows OFFSET', 'Apply the template offset by OFFSET rows') do |v|
-      options.offset[1] = v
-    end
-
     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
-# rubocop:enable Metrics/BlockLength
 
 option_parser.parse!
 
@@ -77,7 +31,12 @@ end
 
 begin
   ::CSVPlusPlus.apply_template_to_sheet!(::ARGF.read, ::ARGF.filename, options)
-rescue ::CSVPlusPlus::Language::SyntaxError => e
-  warn(options.verbose ? e.to_verbose_trace : e.to_trace)
+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