csv_plus_plus 0.1.2 → 0.1.3

data/lib/csv_plus_plus/modifier/data_validation.rb

@@ -0,0 +1,138 @@
+# typed: true
+# frozen_string_literal: true
+
+module CSVPlusPlus
+  module Modifier
+    # A validation on a cell value.  Used to support the `validate=` modifier directive.  This is mostly based on the
+    # Google Sheets API spec:
+    #
+    # @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/other#ConditionType
+    #
+    # @attr_reader arguments [Array<::String>] The parsed arguments as required by the condition.
+    # @attr_reader condition [Symbol] The condition (:blank, :text_eq, :date_before, etc.)
+    # @attr_reader invalid_reason [::String, nil] If set, the reason why this modifier is not valid.
+    class DataValidation
+      attr_reader :arguments, :condition, :invalid_reason
+
+      # @param value [::String] The value to parse as a data validation
+      def initialize(value)
+        condition, args = value.split(/\s*:\s*/)
+        @arguments = ::CSVPlusPlus::Lexer.unquote(args || '').split(/\s+/)
+        @condition = condition.to_sym
+
+        validate!
+      end
+
+      # Each data validation (represented by +@condition+) has their own requirements for which arguments are valid.
+      # If this object is invalid, you can see the reason in +@invalid_reason+.
+      #
+      # @return [boolean]
+      def valid?
+        @invalid_reason.nil?
+      end
+
+      protected
+
+      def invalid!(reason)
+        @invalid_reason = reason
+      end
+
+      def a_number(arg)
+        Float(arg)
+      rescue ::ArgumentError
+        invalid!("Requires a number but given: #{arg}")
+      end
+
+      def a1_notation(arg)
+        return arg if ::CSVPlusPlus::Entities::CellReference.valid_cell_reference?(arg)
+      end
+
+      def a_date(arg, allow_relative_date: false)
+        return arg if ::CSVPlusPlus::Entities::Date.valid_date?(arg)
+
+        if allow_relative_date
+          a_relative_date(arg)
+        else
+          invalid!("Requires a date but given: #{arg}")
+        end
+      end
+
+      def a_relative_date(arg)
+        return arg if %w[past_month past_week past_year yesterday today tomorrow].include?(arg.downcase)
+
+        invalid!('Requires a relative date: past_month, past_week, past_year, yesterday, today or tomorrow')
+      end
+
+      def no_args
+        return if @arguments.empty?
+
+        invalid!("Requires no arguments but #{@arguments.length} given: #{@arguments}")
+      end
+
+      def one_arg
+        return @arguments[0] if @arguments.length == 1
+
+        invalid!("Requires only one argument but #{@arguments.length} given: #{@arguments}")
+      end
+
+      def one_arg_or_more
+        return @arguments if @arguments.length.positive?
+
+        invalid!("Requires at least one argument but #{@arguments.length} given: #{@arguments}")
+      end
+
+      def two_dates
+        return @arguments if @arguments.length == 2 && a_date(@arguments[0]) && a_date(@arguments[1])
+
+        invalid!("Requires exactly two dates but given: #{@arguments}")
+      end
+
+      def two_numbers
+        return @arguments if @arguments.length == 2 && a_number(@arguments[0]) && a_number(@arguments[1])
+
+        invalid!("Requires exactly two numbers but given: #{@arguments}")
+      end
+
+      # validate_boolean is a weird one because it can have 0, 1 or 2 @arguments - all of them must be (true | false)
+      def validate_boolean
+        return @arguments if @arguments.empty?
+
+        converted_args = @arguments.map(&:strip).map(&:downcase)
+        return @arguments if [1, 2].include?(@arguments.length) && converted_args.all? do |arg|
+                               %w[true false].include?(arg)
+                             end
+
+        invalid!("Requires 0, 1 or 2 arguments and they all must be either 'true' or 'false'. Received: #{arguments}")
+      end
+
+      # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/AbcSize
+      def validate!
+        case condition.to_sym
+        when :blank, :date_is_valid, :not_blank, :text_is_email, :text_is_url
+          no_args
+        when :text_contains, :text_ends_with, :text_eq, :text_not_contains, :text_starts_with
+          one_arg
+        when :date_after, :date_before, :date_on_or_after, :date_on_or_before
+          a_date(one_arg, allow_relative_date: true)
+        when :date_eq, :date_not_eq
+          a_date(one_arg)
+        when :date_between, :date_not_between
+          two_dates
+        when :one_of_range
+          a1_notation(one_arg)
+        when :custom_formula, :one_of_list, :text_not_eq
+          one_arg_or_more
+        when :number_eq, :number_greater, :number_greater_than_eq, :number_less, :number_less_than_eq, :number_not_eq
+          a_number(one_arg)
+        when :number_between, :number_not_between
+          two_numbers
+        when :boolean
+          validate_boolean
+        else
+          invalid!('Not a recognized data validation directive')
+        end
+      end
+      # rubocop:enable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/AbcSize
+    end
+  end
+end

data/lib/csv_plus_plus/modifier/expand.rb

@@ -0,0 +1,61 @@
+# typed: strict
+# frozen_string_literal: true
+
+module CSVPlusPlus
+  module Modifier
+    # The logic for how a row can expand
+    #
+    # @attr_reader ends_at [Integer, nil] Once the row has been expanded, where it ends at.
+    # @attr_reader repetitions [Integer, nil] How many times the row repeats/expands.
+    # @attr_reader starts_at [Integer, nil] Once the row has been expanded, where it starts at.
+    class Expand
+      extend ::T::Sig
+
+      sig { returns(::T.nilable(::Integer)) }
+      attr_reader :ends_at
+
+      sig { returns(::T.nilable(::Integer)) }
+      attr_reader :repetitions
+
+      sig { returns(::T.nilable(::Integer)) }
+      attr_reader :starts_at
+
+      sig { params(repetitions: ::T.nilable(::Integer), starts_at: ::T.nilable(::Integer)).void }
+      # @param repetitions [Integer, nil] How many times this expand repeats.  If it's +nil+ it will expand infinitely
+      #   (for the rest of the worksheet.)
+      # @param starts_at [Integer, nil] The final location where the +Expand+ will start.  It's important to note that
+      #   this can't be derived until all rows are expanded, because each expand modifier will push down the ones below
+      #   it.  So typically this param will not be passed in the initializer but instead set later.
+      def initialize(repetitions: nil, starts_at: nil)
+        @repetitions = ::T.let(repetitions, ::T.nilable(::Integer))
+        @starts_at = ::T.let(starts_at, ::T.nilable(::Integer)) unless starts_at.nil?
+        @ends_at = ::T.let(nil, ::T.nilable(::Integer))
+      end
+
+      sig { returns(::T::Boolean) }
+      # Has the row been expanded?
+      #
+      # @return [boolean]
+      def expanded?
+        !@starts_at.nil?
+      end
+
+      sig { returns(::T::Boolean) }
+      # Does this infinitely expand?
+      #
+      # @return [boolean]
+      def infinite?
+        repetitions.nil?
+      end
+
+      sig { params(row_index: ::Integer).void }
+      # Mark the start of the row once it's been expanded, as well as where it +ends_at+.  When expanding rows each one
+      # adds rows to the worksheet and if there are multiple `expand` modifiers in the worksheet, we don't know the
+      # final +row_index+ until we're in the phase of expanding all the rows out.
+      def starts_at=(row_index)
+        @starts_at = row_index
+        @ends_at = row_index + @repetitions unless @repetitions.nil?
+      end
+    end
+  end
+end

data/lib/csv_plus_plus/modifier/google_sheet_modifier.rb

@@ -0,0 +1,133 @@
+# typed: strict
+# frozen_string_literal: true
+
+module CSVPlusPlus
+  module Modifier
+    # Decorate a +Modifier+ so it is more compatible with the Google Sheets API
+    class GoogleSheetModifier < ::CSVPlusPlus::Modifier::Modifier
+      extend ::T::Sig
+
+      sig { returns(::T.nilable(::Google::Apis::SheetsV4::Color)) }
+      # Format the color for Google Sheets
+      #
+      # @return [Google::Apis::SheetsV4::Color]
+      def background_color
+        google_sheets_color(@color) if @color
+      end
+
+      sig { returns(::T.nilable(::Google::Apis::SheetsV4::Border)) }
+      # Format the border for Google Sheets
+      #
+      # @return [Google::Apis::SheetsV4::Border]
+      def border
+        return unless any_border?
+
+        # TODO: allow different border styles per side?
+        ::Google::Apis::SheetsV4::Border.new(
+          color: google_sheets_color(bordercolor || ::CSVPlusPlus::Color.new('#000000')),
+          style: border_style
+        )
+      end
+
+      sig { returns(::T.nilable(::Google::Apis::SheetsV4::Color)) }
+      # Format the fontcolor for Google Sheets
+      #
+      # @return [Google::Apis::SheetsV4::Color]
+      def font_color
+        google_sheets_color(@fontcolor) if @fontcolor
+      end
+
+      sig { returns(::T.nilable(::String)) }
+      # Format the halign for Google Sheets
+      #
+      # @return [::String]
+      def horizontal_alignment
+        halign&.serialize&.upcase
+      end
+
+      sig { returns(::T.nilable(::Google::Apis::SheetsV4::NumberFormat)) }
+      # Format the numberformat for Google Sheets
+      #
+      #
+      # @return [Google::Apis::SheetsV4::NumberFormat]
+      def number_format
+        ::Google::Apis::SheetsV4::NumberFormat.new(type: number_format_type(@numberformat)) if @numberformat
+      end
+
+      sig { returns(::Google::Apis::SheetsV4::TextFormat) }
+      # Builds a SheetsV4::TextFormat with the underlying Modifier
+      #
+      # @return [Google::Apis::SheetsV4::TextFormat]
+      def text_format
+        ::Google::Apis::SheetsV4::TextFormat.new(
+          bold: formatted?(::CSVPlusPlus::Modifier::TextFormat::Bold) || nil,
+          italic: formatted?(::CSVPlusPlus::Modifier::TextFormat::Italic) || nil,
+          strikethrough: formatted?(::CSVPlusPlus::Modifier::TextFormat::Strikethrough) || nil,
+          underline: formatted?(::CSVPlusPlus::Modifier::TextFormat::Underline) || nil,
+          font_family: fontfamily,
+          font_size: fontsize,
+          foreground_color: font_color
+        )
+      end
+
+      sig { returns(::T.nilable(::String)) }
+      # Format the valign for Google Sheets
+      def vertical_alignment
+        valign&.serialize&.upcase
+      end
+
+      private
+
+      sig { returns(::T.nilable(::String)) }
+      # Format the border style for Google Sheets
+      #
+      # @see https://developers.google.com/apps-script/reference/spreadsheet/border-style
+      #
+      # @return [::String, nil]
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def border_style
+        return 'SOLID' unless @borderstyle
+
+        case @borderstyle
+        when ::CSVPlusPlus::Modifier::BorderStyle::Dashed then 'DASHED'
+        when ::CSVPlusPlus::Modifier::BorderStyle::Dotted then 'DOTTED'
+        when ::CSVPlusPlus::Modifier::BorderStyle::Double then 'DOUBLE'
+        when ::CSVPlusPlus::Modifier::BorderStyle::Solid then 'SOLID'
+        when ::CSVPlusPlus::Modifier::BorderStyle::SolidMedium then 'SOLID_MEDIUM'
+        when ::CSVPlusPlus::Modifier::BorderStyle::SolidThick then 'SOLID_THICK'
+        else ::T.absurd(@borderstyle)
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      sig { params(color: ::CSVPlusPlus::Color).returns(::Google::Apis::SheetsV4::Color) }
+      def google_sheets_color(color)
+        ::Google::Apis::SheetsV4::Color.new(
+          red: color.red_percent,
+          green: color.green_percent,
+          blue: color.blue_percent
+        )
+      end
+
+      sig { params(numberformat: ::CSVPlusPlus::Modifier::NumberFormat).returns(::String) }
+      # @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#NumberFormat
+      #
+      # @return [::String]
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+      def number_format_type(numberformat)
+        case numberformat
+        when ::CSVPlusPlus::Modifier::NumberFormat::Currency then 'CURRENCY'
+        when ::CSVPlusPlus::Modifier::NumberFormat::Date then 'DATE'
+        when ::CSVPlusPlus::Modifier::NumberFormat::DateTime then 'DATE_TIME'
+        when ::CSVPlusPlus::Modifier::NumberFormat::Number then 'NUMBER'
+        when ::CSVPlusPlus::Modifier::NumberFormat::Percent then 'PERCENT'
+        when ::CSVPlusPlus::Modifier::NumberFormat::Text then 'TEXT'
+        when ::CSVPlusPlus::Modifier::NumberFormat::Time then 'TIME'
+        when ::CSVPlusPlus::Modifier::NumberFormat::Scientific then 'SCIENTIFIC'
+        else ::T.absurd(numberformat)
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength
+    end
+  end
+end

data/lib/csv_plus_plus/modifier/modifier.rb

@@ -0,0 +1,222 @@
+# typed: strict
+# frozen_string_literal: true
+
+module CSVPlusPlus
+  module Modifier
+    # A container representing the operations that can be applied to a cell or row
+    #
+    # @attr bordercolor [Color, nil]
+    # @attr color [Color, nil] The background color of the cell
+    # @attr expand [Modifier::Expand, nil] Whether this row expands into multiple rows
+    # @attr fontcolor [Color, nil] The font color of the cell
+    # @attr fontfamily [::String, nil] The font family
+    # @attr fontsize [Numeric, nil] The font size
+    # @attr halign [Modifier::HorizontalAlign, nil] Horizontal alignment
+    # @attr note [::String, nil] A note/comment on the cell
+    # @attr numberformat [Modifier::NumberFormat, nil] A number format to apply to the value in the cell
+    # @attr row_level [T::Boolean] Is this a row modifier? If so it's values will apply to all cells in the row
+    #   (unless overridden by the cell modifier)
+    # @attr validate [Modifier::DataValidation, nil]
+    # @attr valign [Modifier::VerticalAlign, nil] Vertical alignment
+    # @attr var [Symbol, nil] The variable bound to this cell
+    #
+    # @attr_writer borderstyle [Modifier::BorderStyle] The style of border on the cell
+    #
+    # @attr_reader borders [Set<Modifier::BorderSide>] The sides of the cell where a border will be applied.
+    # @attr_reader formats [Set<Modifier::TextFormat>] Bold/italics/underline and strikethrough formatting.
+    #
+    # rubocop:disable Metrics/ClassLength
+    class Modifier
+      extend ::T::Sig
+
+      sig { returns(::T.nilable(::CSVPlusPlus::Color)) }
+      attr_accessor :bordercolor
+
+      sig { returns(::T.nilable(::CSVPlusPlus::Color)) }
+      attr_accessor :color
+
+      sig { returns(::T.nilable(::CSVPlusPlus::Modifier::Expand)) }
+      attr_accessor :expand
+
+      sig { returns(::T.nilable(::CSVPlusPlus::Color)) }
+      attr_accessor :fontcolor
+
+      sig { returns(::T.nilable(::String)) }
+      attr_accessor :fontfamily
+
+      sig { returns(::T.nilable(::Numeric)) }
+      attr_accessor :fontsize
+
+      sig { returns(::T.nilable(::CSVPlusPlus::Modifier::HorizontalAlign)) }
+      attr_accessor :halign
+
+      sig { returns(::T.nilable(::String)) }
+      attr_accessor :note
+
+      sig { returns(::T.nilable(::CSVPlusPlus::Modifier::NumberFormat)) }
+      attr_accessor :numberformat
+
+      sig { returns(::T::Boolean) }
+      attr_accessor :row_level
+
+      sig { returns(::T.nilable(::CSVPlusPlus::Modifier::DataValidation)) }
+      attr_accessor :validate
+
+      sig { returns(::T.nilable(::CSVPlusPlus::Modifier::VerticalAlign)) }
+      attr_accessor :valign
+
+      sig { returns(::T.nilable(::Symbol)) }
+      attr_accessor :var
+
+      sig { returns(::T::Set[::CSVPlusPlus::Modifier::BorderSide]) }
+      attr_reader :borders
+
+      sig { returns(::T::Set[::CSVPlusPlus::Modifier::TextFormat]) }
+      attr_reader :formats
+
+      sig do
+        params(borderstyle: ::CSVPlusPlus::Modifier::BorderStyle)
+          .returns(::T.nilable(::CSVPlusPlus::Modifier::BorderStyle))
+      end
+      attr_writer :borderstyle
+
+      sig { params(row_level: ::T::Boolean).void }
+      # @param row_level [Boolean] Whether or not this modifier applies to the entire row
+      def initialize(row_level: false)
+        @row_level = row_level
+        @frozen = ::T.let(false, ::T::Boolean)
+        @borders = ::T.let(::Set.new, ::T::Set[::CSVPlusPlus::Modifier::BorderSide])
+        @formats = ::T.let(::Set.new, ::T::Set[::CSVPlusPlus::Modifier::TextFormat])
+      end
+
+      sig { returns(::T::Boolean) }
+      # Are there any borders set?
+      #
+      # @return [::T::Boolean]
+      def any_border?
+        !@borders.empty?
+      end
+
+      sig { returns(::CSVPlusPlus::Modifier::BorderStyle) }
+      # Style of the border
+      #
+      # @return [::CSVPlusPlus::Modifier::BorderStyle]
+      def borderstyle
+        @borderstyle || ::CSVPlusPlus::Modifier::BorderStyle::Solid
+      end
+
+      sig { returns(::T::Boolean) }
+      # Is this a cell-level modifier?
+      #
+      # @return [T::Boolean]
+      def cell_level?
+        !@row_level
+      end
+
+      sig { params(side: ::CSVPlusPlus::Modifier::BorderSide).returns(::T::Set[::CSVPlusPlus::Modifier::BorderSide]) }
+      # Put a border on the given +side+
+      #
+      # @param side [Modifier::BorderSide]
+      def border=(side)
+        @borders << side
+      end
+
+      sig { params(side: ::CSVPlusPlus::Modifier::BorderSide).returns(::T::Boolean) }
+      # Does this have a border along +side+?
+      #
+      # @param side [Modifier::BorderSide]
+      #
+      # @return [T::Boolean]
+      def border_along?(side)
+        @borders.include?(::CSVPlusPlus::Modifier::BorderSide::All) || @borders.include?(side)
+      end
+
+      sig { returns(::T::Boolean) }
+      # Does this have a border along all sides?
+      #
+      # @return [T::Boolean]
+      def border_all?
+        @borders.include?(::CSVPlusPlus::Modifier::BorderSide::All) \
+          || (border_along?(::CSVPlusPlus::Modifier::BorderSide::Top) \
+              && border_along?(::CSVPlusPlus::Modifier::BorderSide::Bottom) \
+              && border_along?(::CSVPlusPlus::Modifier::BorderSide::Left) \
+              && border_along?(::CSVPlusPlus::Modifier::BorderSide::Right))
+      end
+
+      sig { returns(::T.nilable(::CSVPlusPlus::Modifier::Expand)) }
+      # Set this modifier to expand infinitely
+      #
+      # @return [Expand, nil]
+      def infinite_expand!
+        @expand = ::CSVPlusPlus::Modifier::Expand.new if row_level?
+      end
+
+      sig { params(format: ::CSVPlusPlus::Modifier::TextFormat).returns(::T::Set[::CSVPlusPlus::Modifier::TextFormat]) }
+      # Set a text format (bolid, italic, underline or strikethrough)
+      #
+      # @param format [TextFormat]
+      def format=(format)
+        @formats << format
+      end
+
+      sig { params(format: ::CSVPlusPlus::Modifier::TextFormat).returns(::T::Boolean) }
+      # Is the given format set?
+      #
+      # @param format [TextFormat]
+      #
+      # @return [T::Boolean]
+      def formatted?(format)
+        @formats.include?(format)
+      end
+
+      sig { returns(::T::Boolean) }
+      # Freeze the row or cell from edits
+      #
+      # @return [true]
+      def freeze!
+        @frozen = true
+      end
+
+      sig { returns(::T::Boolean) }
+      # Is the cell or row frozen from edits?
+      #
+      # @return [T::Boolean]
+      def frozen?
+        @frozen
+      end
+
+      sig { returns(::T::Boolean) }
+      # Mark this modifer as row-level
+      #
+      # @return [true]
+      def row_level!
+        @row_level = true
+      end
+
+      sig { returns(::T::Boolean) }
+      # Is this a row-level modifier?
+      #
+      # @return [T::Boolean]
+      def row_level?
+        @row_level
+      end
+
+      sig { params(other: ::CSVPlusPlus::Modifier::Modifier).void }
+      # Create a new modifier instance, with all values defaulted from +other+
+      #
+      # @param other [Modifier]
+      #
+      # @return [Modifier]
+      def take_defaults_from!(other)
+        other.instance_variables.each do |property|
+          # don't propagate row-specific values
+          next if property == :@row_level
+
+          value = other.instance_variable_get(property)
+          instance_variable_set(property, value.clone)
+        end
+      end
+    end
+    # rubocop:enable Metrics/ClassLength
+  end
+end