joined 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 508cc1389e031ef74fd7e700066a4b7642d10db2754acc384670fce2277ea68d
-  data.tar.gz: c69ddae19a6ddaaeb349111a5cb076f3fb75466584d98953c0c93d47d6247564
+  metadata.gz: bf39163ca7677fe7c82b64f86a58ed1960ab37ff099a3d3530a98604d0db8d2f
+  data.tar.gz: cac313f36a472d3543f1f61b0d23e428484ebf26dcdf78a8ee8e7001527a17ce
 SHA512:
-  metadata.gz: a34b32456b37ec9fb5fcba35b64a28153b4eb76bf89e8afadec977df8f7ad9d1dbf9b4aee90b9df01d915734531355e5ed41ea5970a5cd9e70b51bd488216d06
-  data.tar.gz: c5b39a60e832cdee4b2a1e02a16b31501bbdf0718c5fd04fef4e1b9243054e713d197203051476dc6387c5d9492d492ed8e2c3279d3d697d9b46e087fb6f41c2
+  metadata.gz: 17ac3bfd0677cde3c1caf8e49b52c24addeaa3512053e6aa60b21a36b9c574b67df9834bdd5068159c78186bc3c3ab40b87d02cb7d9e6ff1074492bf3bbdf047
+  data.tar.gz: 978bbf113d2e52aa15dfc935c219dc2cca47fdc0cea9f84671f6083bc472b193c8085ea4251a0f58a79027c3348d26e23734ff725cfce799c0cdb712f77779ae

data/.github/workflows/typos.yml

@@ -0,0 +1,19 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+---
+# yamllint disable rule:line-length
+name: typos
+'on':
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  typos:
+    timeout-minutes: 15
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: crate-ci/typos@v1.32.0

data/.gitignore

@@ -1,8 +1,9 @@
-*.gem
-.DS_Store
 .bundle/
+.DS_Store
 .idea/
 .yardoc/
+*.gem
+.ruby-*
 coverage/
 doc/
 node_modules/

data/.rubocop.yml

@@ -18,3 +18,4 @@ Layout/EndOfLine:
   EnforcedStyle: lf
 Style/EvalWithLocation:
   Enabled: false
+require: []

data/Gemfile.lock

@@ -10,8 +10,8 @@ GEM
     ast (2.4.3)
     builder (3.3.0)
     docile (1.4.1)
-    json (2.11.3)
-    language_server-protocol (3.17.0.4)
+    json (2.12.0)
+    language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     minitest (5.25.5)
     minitest-reporters (1.7.1)
@@ -29,7 +29,7 @@ GEM
     rake (13.2.1)
     regexp_parser (2.10.0)
     rexml (3.4.1)
-    rubocop (1.75.4)
+    rubocop (1.75.6)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)

data/README.md

@@ -27,6 +27,25 @@ orange, banana, and pear
 
 That's it.
 
+## Options
+
+The `joined` method supports the following parameters:
+
+* `words_connector` (String) (defaults to: ', ') -
+  the string used to join all but the last element of the list.
+* `last_word_connector` (String) (defaults to: ', and ') -
+  the string used to join the last element of the list.
+* `oxford` (Boolean) (defaults to: true) -
+  should we place a comma before the `last_word_connector`?
+  If false, it will remove a leading comma from the `last_word_connector`.
+  If true, it will preserve the leading comma specified
+  in the `last_word_connector`, but it will not insert one
+  if not already present.
+
+See the
+[Yard docs](https://rubydoc.info/github/yegor256/joined/master/frames)
+for full gem documentation.
+
 ## How to contribute
 
 Read

data/REUSE.toml

@@ -4,9 +4,17 @@
 version = 1
 [[annotations]]
 path = [
+    ".DS_Store",
+    ".gitattributes",
+    ".gitignore",
+    ".pdd",
     "**.json",
     "**.md",
+    "**.png",
     "**.txt",
+    "**/.DS_Store",
+    "**/.gitignore",
+    "**/.pdd",
     "**/*.csv",
     "**/*.jpg",
     "**/*.json",
@@ -16,15 +24,8 @@ path = [
     "**/*.svg",
     "**/*.txt",
     "**/*.vm",
-    "**/.DS_Store",
-    "**/.gitignore",
-    "**/.pdd",
     "**/CNAME",
     "**/Gemfile.lock",
-    ".DS_Store",
-    ".gitattributes",
-    ".gitignore",
-    ".pdd",
     "Gemfile.lock",
     "README.md",
     "renovate.json",

data/joined.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.required_ruby_version = '>=3.2'
   s.name = 'joined'
-  s.version = '0.1.0'
+  s.version = '0.3.0'
   s.license = 'MIT'
   s.summary = 'A simple Ruby gem that adds a .joined() method to Array'
   s.description =

data/lib/joined.rb

@@ -12,12 +12,31 @@ class Array
   # Join strings into a single line, splitting them with comma
   # and placing "AND" between the last two items.
   #
-  # @param [Boolean] oxford Should we place a comma before AND?
-  # @return [String] The text generated
-  def joined(oxford: true)
+  # @param [String] words_connector
+  #   The string used to join all but the last element of the list
+  # @param [String] last_word_connector
+  #   The string used to join the last element of the list.
+  # @param [Boolean] oxford
+  #   Should we place a comma before the :last_word_connector?
+  #   If false, it will remove a leading comma from the :last_word_connector.
+  #   If true, it will preserve the leading comma specified
+  #   in the :last_word_connector, but it will not insert one
+  #   if not already present.
+  # @param [Boolean] comma_before
+  #   Should we move comma before the quotes symbol
+  #   If false, it will do nothing
+  #   If true, it will move all commas before the quotes
+  # @return [String] The text generated (with items joined)
+  def joined(oxford: true, words_connector: ', ', last_word_connector: ', and ', comma_before: false)
     return '' if empty?
     return first if length == 1
 
-    "#{self[0...-1].join(', ')}#{',' if length > 2 && oxford} and #{self[-1]}"
+    final_connector = (last_word_connector || '').dup
+    final_connector.sub!(/^,/, '') unless oxford && length > 2
+
+    result = "#{self[0...-1].join(words_connector)}#{final_connector}#{self[-1]}"
+    return result.gsub(/"([^"]+)"\s*,/, '"\1,"') if comma_before
+
+    result
   end
 end

data/test/test_joined.rb

@@ -25,4 +25,47 @@ class Testjoined < Minitest::Test
     assert_equal('apple, banana and orange', %w[apple banana orange].joined(oxford: false))
     assert_equal('apple, banana, orange and pear', %w[apple banana orange pear].joined(oxford: false))
   end
+
+  def test_with_words_connector
+    assert_equal('one two, and three', %w[one two three].joined(words_connector: ' '))
+    assert_equal('one & two, and three', %w[one two three].joined(words_connector: ' & '))
+    assert_equal('onetwo, and three', %w[one two three].joined(words_connector: nil))
+  end
+
+  def test_with_last_word_connector
+    assert_equal 'one, two, and also three', %w[one two three].joined(last_word_connector: ', and also ')
+    assert_equal 'one, two and also three', %w[one two three].joined(last_word_connector: ' and also ')
+    assert_equal 'one, twothree', %w[one two three].joined(last_word_connector: nil)
+    assert_equal 'one, two three', %w[one two three].joined(last_word_connector: ' ')
+    assert_equal 'one, two and three', %w[one two three].joined(last_word_connector: ' and ')
+  end
+
+  def test_with_last_word_connector_but_without_oxford_comma
+    assert_equal 'one, two and also three', %w[one two three].joined(oxford: false, last_word_connector: ', and also ')
+    assert_equal 'one, two and also three', %w[one two three].joined(oxford: false, last_word_connector: ' and also ')
+    assert_equal 'one, twothree', %w[one two three].joined(oxford: false, last_word_connector: nil)
+    assert_equal 'one, two three', %w[one two three].joined(oxford: false, last_word_connector: ' ')
+    assert_equal 'one, two and three', %w[one two three].joined(oxford: false, last_word_connector: ' and ')
+  end
+
+  def test_two_elements
+    assert_equal 'one and two', %w[one two].joined
+    assert_equal 'one two', %w[one two].joined(last_word_connector: ' ')
+  end
+
+  def test_one_element
+    assert_equal 'one', ['one'].joined
+  end
+
+  def test_with_invalid_options
+    exception = assert_raises ArgumentError do
+      %w[one two].joined(passing: 'invalid option')
+    end
+
+    assert_equal 'unknown keyword: :passing', exception.message
+  end
+
+  def test_with_comma_before
+    assert_equal '"one," "two," and "three"', %w[one two three].map { |f| "\"#{f}\"" }.joined(comma_before: true)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: joined
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -29,6 +29,7 @@ files:
 - ".github/workflows/pdd.yml"
 - ".github/workflows/rake.yml"
 - ".github/workflows/reuse.yml"
+- ".github/workflows/typos.yml"
 - ".github/workflows/xcop.yml"
 - ".github/workflows/yamllint.yml"
 - ".gitignore"