csv_plus_plus 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11364af3824cbfff63df10d7b932a6ad2c7a222e1a40b39f151af82a150d5dc4
-  data.tar.gz: 2d6fe31ae0e6a7dee0c19f31b0328e1b20973541c6e2c12cb64f3fbf96d8fa02
+  metadata.gz: c4f5c9b5a342102fa8e1c31b319fb05f19ad55278bc633435129254b5b2511a8
+  data.tar.gz: 0c2656d4d7b22d0b3b3311745ed5a70b789277c622f0f2d09d2b8a144de71a8d
 SHA512:
-  metadata.gz: 623953f6ff728e1dfc1f7f329dbc89e5ae7b7687cebd6da387ea36f0b0659020142e5f2029533e46964b8bf51c2f78b79634b9bb346cad6e6c96ae69d6737fb1
-  data.tar.gz: 0604bc094e8d287bcec1390ff884786fe8dbf12b5e6e4ec4785cc9cef2297f92360a9a60809c855630edd5f633b2bc16bf378cb0c47a1be7eb2a7f70ae6beb7a
+  metadata.gz: 90965e2275cc7988f4054b59e30523cd645b21c1adb89797828e86a767217b09ac174bbc17094604dd608b93defd79f4c9a74ccf7e2f20dd17995f8c1b5dadac
+  data.tar.gz: 291011896232e88a7bd0e252887459986812d2877c1d0383458250e1c30cf735d8b2bdaf5dd759f44fa5b8b33b08f74d780df7960622ab774e9f6d856628508f

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## v0.0.5
+
+- Support the --backup/-b option
+- bin/csvpp (which does the same thing as bin/csv++ but will work better on other filesystems)
+- Fix links in gemspec (which end up on rubygems.org)
+- docs & tests
+
+## 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)
@@ -21,12 +21,17 @@ def profit() (price * quantity) - fees
 ![[expand]],[[format=bold]],,,"=PROFIT()",$$fees
 ```
 
-## Predefined Variables
+## Variables
 
-* `$$rownum` - The current row number.  The first row of the spreadsheet starts at 1
+Variables can be defined in the code section by giving a name (a combination of letters, numbers and underscores ) the expression `:=` and followed with a value.
 
-## Predefined Functions
+### Built-in Variables
 
+* `$$rownum` - The current row number.  The first row of the spreadsheet starts at 1.  Can be used anywhere and it's value will evaluate to the current row being processed.
+
+## Functions
+
+### Built-in 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

data/bin/csv++

@@ -1,83 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'optparse'
 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
-  end
-# rubocop:enable Metrics/BlockLength
-
-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::Language::SyntaxError => e
-  warn(options.verbose ? e.to_verbose_trace : e.to_trace)
-  exit(1)
-end
+::CSVPlusPlus::CLI.launch_compiler!

data/bin/csvpp

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/csv_plus_plus'
+
+::CSVPlusPlus::CLI.launch_compiler!

data/lib/csv_plus_plus/cli.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module CSVPlusPlus
+  # Handle running the application with the given CLI flags
+  class CLI
+    # handle any CLI flags and launch the compiler
+    def self.launch_compiler!
+      cli = new
+      cli.compile!
+    rescue ::StandardError => e
+      cli.handle_error(e)
+      exit(1)
+    end
+
+    # initialize
+    def initialize
+      parse_options!
+    end
+
+    # compile the given template, using the given CLI flags
+    def compile!
+      ::CSVPlusPlus.apply_template_to_sheet!(::ARGF.read, ::ARGF.filename, @options)
+    end
+
+    # (nicely) handle a given error.  how it's handled depends on if it's our error and if @options.verbose
+    def handle_error(error)
+      case error
+      when ::CSVPlusPlus::Error
+        handle_internal_error(error)
+      when ::Google::Apis::ClientError
+        handle_google_error(error)
+      else
+        # TODO: more if verbose?
+        warn(error.message)
+      end
+    end
+
+    private
+
+    def handle_internal_error(error)
+      if error.is_a?(::CSVPlusPlus::Language::SyntaxError)
+        warn(@options.verbose ? error.to_verbose_trace : error.to_trace)
+      else
+        warn(error.message)
+      end
+    end
+
+    def handle_google_error(error)
+      warn("Error making Google Sheets API request: #{error.message}")
+      return unless @options.verbose
+
+      warn("#{error.status_code} Error making Google API request [#{error.message}]: #{error.body}")
+    end
+
+    def parse_options!
+      @options = ::CSVPlusPlus::Options.new
+      option_parser.parse!
+      validate_options
+    end
+
+    def validate_options
+      error_message = @options.validate
+      return if error_message.nil?
+
+      puts(option_parser)
+      raise(::CSVPlusPlus::Error, error_message)
+    end
+
+    def option_parser
+      ::OptionParser.new do |parser|
+        parser.on('-h', '--help', 'Show help information') do
+          puts(parser)
+          exit
+        end
+
+        ::SUPPORTED_CSVPP_FLAGS.each do |f|
+          parser.on(f.short_flag, f.long_flag, f.description) { |v| f.handler.call(@options, v) }
+        end
+      end
+    end
+  end
+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/google_api_client.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CSVPlusPlus
+  # A convenience wrapper around Google's REST API client
+  module GoogleApiClient
+    # Get a +::Google::Apis::SheetsV4::SheetsService+ instance connected to the sheets API
+    def self.sheets_client
+      ::Google::Apis::SheetsV4::SheetsService.new.tap do |s|
+        s.authorization = ::Google::Auth.get_application_default(['https://www.googleapis.com/auth/spreadsheets'].freeze)
+      end
+    end
+
+    # Get a +::Google::Apis::DriveV3::DriveService+ instance connected to the drive API
+    def self.drive_client
+      ::Google::Apis::DriveV3::DriveService.new.tap do |d|
+        d.authorization = ::Google::Auth.get_application_default(['https://www.googleapis.com/auth/drive.file'].freeze)
+      end
+    end
+  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/entities/boolean.rb

@@ -5,24 +5,24 @@ require_relative './entity'
 module CSVPlusPlus
   module Language
     module Entities
-      ##
       # A boolean value
       class Boolean < Entity
         attr_reader :value
 
         # initialize
+        # @param value [String, Boolean]
         def initialize(value)
           super(:boolean)
           # TODO: probably can do a lot better in general on type validation
           @value = value.is_a?(::String) ? (value.downcase == 'true') : value
         end
 
-        # to_s
+        # @return [String]
         def to_s
           @value.to_s.upcase
         end
 
-        # ==
+        # @return [Boolean]
         def ==(other)
           super && value == other.value
         end

data/lib/csv_plus_plus/language/entities/entity.rb

@@ -9,13 +9,14 @@ module CSVPlusPlus
       class Entity
         attr_reader :id, :type
 
-        # initialize
+        # @param type [String, Symbol]
+        # @param id [String]
         def initialize(type, id: nil)
           @type = type.to_sym
           @id = id.downcase.to_sym if id
         end
 
-        # ==
+        # @return [Boolean]
         def ==(other)
           self.class == other.class && @type == other.type && @id == other.id
         end
@@ -30,7 +31,8 @@ module CSVPlusPlus
           end
         end
 
-        # support predicates by type
+        # Respond to predicates by type (entity.boolean?, entity.string?, etc)
+        # @return [Boolean]
         def respond_to_missing?(method_name, *_arguments)
           (method_name =~ /^(\w+)\?$/ && a_type?(::Regexp.last_match(1))) || super
         end
@@ -42,17 +44,19 @@ module CSVPlusPlus
         end
       end
 
-      # An entity that can take arguments
+      # An entity that can take other entities as arguments
       class EntityWithArguments < Entity
         attr_reader :arguments
 
-        # initialize
+        # @param type [String, Symbol]
+        # @param id [String]
+        # @param arguments [Array<Entity>]
         def initialize(type, id: nil, arguments: [])
           super(type, id:)
           @arguments = arguments
         end
 
-        # ==
+        # @return [Boolean]
         def ==(other)
           super && @arguments == other.arguments
         end

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