fstrings 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7380d3cac8fb3aefc682a76ad4494ab1d073ce0d9151282cd308da13e4d816e3
+  data.tar.gz: 2c68d89360ab486f60afac7b26282f1cd16fb4039d507ec586ce78906fa7c786
+SHA512:
+  metadata.gz: 73ca4f916f6ce4da769ca3e4bf4abe44b7b4245e56ab9654bc2798a43e30967fc9c4f6fcec0b0c23992fab62bd6c6420e15e85a1c852e7c61d64d2071bf8374b
+  data.tar.gz: 303bd05300946f90da31bb282cac0e08221387e81d907320b997a98205701d3bc1c6526cd8cdcf588577ae94173d87fb32bfe51d5e13da80f28bc0b7628a4d0a

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Victor 'Zverok' Shepelev
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# FStrings
+
+FStrings is an _experimental_ gem implementing Python-alike fstrings (formatting strings) in Ruby.
+
+The idea is, in Ruby, we have two ways to insert some variable values in strings:
+
+1. String interpolation: `puts "Foo #{value} bar"`
+2. `String#%` (or `Kernel#format`, if you want): `puts "Foo %.2f value" % value`
+
+First is more convenient (with the variable name where it should be rendered), while the second is much more powerful, allowing to specify various formatting flags. `FStrings` tries to close this gap, with a bit of idea stealing (from the [Python](https://www.python.org/dev/peps/pep-0498/)) and a bit of dark magic ([binding_of_caller](http://github.com/banister/binding_of_caller)).
+
+## Showcase
+
+In its basic form, FStrings formatting looks just like string interpolation (just using `{}` instead of `#{}`):
+
+```ruby
+require 'fstrings'
+include FStrings
+
+value = 5
+puts f"Simple: {value}"
+# => "Simple: 5"
+```
+
+But it also allows to specify formatting flags, after `%` sign (the regular [Kernel#format](https://ruby-doc.org/core-2.7.0/Kernel.html#method-i-format)'s syntax works):
+
+```ruby
+puts f"Formatted: {value%+i}"
+# => "Formatted: +5"
+
+float = 1.2345
+puts f"Formatted: {float%.2f}"
+# => "Formatted: 1.23"
+```
+
+That's mostly it! But not **all** of it :)
+
+FStrings also support **`x=` syntax** (borrowed from the recent [Python 3.8](https://docs.python.org/3/whatsnew/3.8.html#f-strings-support-for-self-documenting-expressions-and-debugging)), indispensable for `puts`-debugging:
+
+```ruby
+puts f"Named: {value=%+i}"
+# => "Named: value=+5"
+
+# Any expression can be interpolated this way:
+r = 12
+puts f"Circle area: {Math::PI * r**2 = %.3f}"
+# => "Circle area: Math::PI * r**2 = 452.389"
+```
+
+FStrings allows to define **custom formatters** for your own classes, and automatically define one for `Time` (it passes the format string to `strftime`):
+
+```ruby
+puts f"Current time is {Time.now %H:%M (%b %d)}"
+# => "Current time is 15:00 (Jan 07)"
+```
+
+To define your own, just do this:
+
+```ruby
+Point = Struct.new(:x, :y)
+# First argument is formatted value, second is format string
+FStrings.def_formatter(Point) { |val, str| str.gsub('%x', val.x.to_s).gsub('%y', val.y.to_s) }
+
+point = Point.new(10, 20)
+
+puts f"See, it works: {point %x;%y}"
+# => "See, it works: 10;20"
+```
+
+(The formatting strings considered everything starting from the first `%` including it.)
+
+## Quirks and problems
+
+The library is _new and experimental_. It is _probably_ helpful in debugging, but probably not advised for any production. The problems I can think of:
+
+* `binding_of_caller` and `eval` are used inside. It is black and unholy magic, obviously;
+* funny `f"foo"` syntax is used to make it look like Python's native fstrings, which could be repulsive for some. In fact, it is just `f()` method, you can use it without `include FStrings`, with just `FStrings.f()`;
+* fstrings-parser is not that mature; it is tested, but can break on more complicated strings (which you hopefully won't need for debugging);
+* probably, parsed strings should be cached, currently, they are not (so in a method which you call 2 mln times, could provide serious slowdown);
+* considering simplistic formatting string definition, statements using `%` can't be inspected (everything after `%` would be thought to be a formatting string).
+
+## Author & license
+
+* [Victor Shepelev](https://zverok.github.io)
+* MIT.

data/lib/fstrings.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'binding_of_caller'
+require 'strscan'
+
+require_relative 'fstrings/formats'
+require_relative 'fstrings/parser'
+
+# Python-alike fstrings (formatting strings) with a Ruby flavour.
+#
+# @example
+#   include FStrings
+#
+#   i = 1
+#   f = 1.23
+#
+#   # Basic form: Just like #{}
+#   f"Simple! {i}"
+#   # => "Simple! 1"
+#
+#   # Inline formatting is supported, same flags as Kernel#format
+#   f"Look: {i%+i}"
+#   # => "Look: +1"
+#   f"Floats... {f%.1f}"
+#   # => "Floats... 1.2"
+#
+#   # Any statement is supported:
+#   f"The whole statement: {i + f %.1f}"
+#   # => "The whole statement: 2.2"
+#
+#   # = at the end of statement handy for debugging:
+#   f"Variable names, too! {i + f = %.1f}"
+#   # => "Variable names, too! i + f = 2.2"
+#
+#   # Time and date formatting is supported:
+#   f"Currently, it is {Time.now %H:%M (at %b %d)}"
+#   # => "Currently, it is 14:31 (at Jan 07)"
+#
+#   # Custom object formatting definition is supported:
+#   Point = Struct.new(:x, :y)
+#   FStrings.def_formatter(Point) { |val, fmtstring| fmtstring % [val.x, val.y] }
+#   f"The point: [{p= %.1f;%.1f}]"
+#   # => "The point: [p= 1.3;2.5]"
+#
+module FStrings
+  # Main library's interface. See {FStrings} main docs for examples.
+  # @param string [String] Formatting string
+  # @return String
+  def f(string)
+    # TODO: cache str2code results?
+    binding.of_caller(1).eval(Parser.str2code(string))
+  end
+
+  extend self
+
+  # Define custom formatters for user classes. Formatting block should accept `value` of
+  # specified class, and formatting `string`, and return string.
+  #
+  # See main {FStrings} docs for a (simplistic) example of usage.
+  #
+  # @param klass [Module] Type of values the formatter is defined for.
+  # @yield value Of the specified `klass`
+  # @yield fmtstring [String] What was after `%` sign in the fstring (including `%` itself)
+  # @yieldreturn String
+  #
+  def self.def_formatter(klass, &formatter)
+    Formats[klass] = formatter
+  end
+
+  def_formatter(Object) { |val, string| string % val }
+  def_formatter(Time, &:strftime)
+  require 'date'
+  def_formatter(Date, &:strftime)
+  def_formatter(DateTime, &:strftime)
+end

data/lib/fstrings/formats.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module FStrings
+  # @private
+  module Formats
+    class << self
+      def formats
+        @formats ||= {}
+      end
+
+      def []=(klass, formatter)
+        formats[klass] = formatter
+      end
+
+      def for(klass)
+        formats.select { |k,| klass <= k }.min_by { |k,| klass.ancestors.index(k) }.last
+      end
+
+      def apply(val, format)
+        self.for(val.class).call(val, format)
+      end
+    end
+  end
+end

data/lib/fstrings/parser.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module FStrings
+  # @private
+  module Parser
+    using(Module.new do
+      refine String do
+        def to_proc
+          method(:%).to_proc
+        end
+      end
+    end)
+
+    class << self
+      def str2code(string)
+        res = []
+        scan = StringScanner.new(string)
+        until scan.eos?
+          res << scan_simple(scan).inspect
+          res << statement2code(scan_statement(scan)) unless scan.eos?
+        end
+        res.join(' + ')
+      end
+
+      private
+
+      def scan_simple(scan)
+        str = scan.scan_until(/\{|$/)
+        if scan.peek(1) == '{'
+          str + scan.scan(/\{/) + scan_simple(scan)
+        else
+          str.sub(/\{$/, '')
+        end
+      end
+
+      def scan_statement(scan)
+        expr, char = scan.scan_until(/[}%]/).then { |str| [str[0...-1], str[-1]] }
+        # fmt will include the first %-char which also signifies it
+        fmt, = scan.scan_until(/\}/).then { |str| [str[0...-1], str[-1]] } if char == '%'
+        if expr.match?(/\s*=\s*$/)
+          prefix = expr
+          expr = expr.sub(/\s*=\s*$/, '')
+        end
+        {expr: expr.strip, fmt: fmt&.then(&'%%%s'), prefix: prefix}
+      end
+
+      def statement2code(expr:, fmt:, prefix:)
+        [
+          prefix&.then(&'%p +'),
+          fmt&.then { 'FStrings::Formats.apply(' },
+          '(',
+          expr,
+          ')',
+          fmt&.then(&', %p)'),
+          '.to_s'
+        ].compact.join
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: fstrings
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Victor Shepelev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: saharspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: '    Python-alike formatting strings with Ruby flavour: f"{x=%.2f}"
+
+'
+email: zverok.offline@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/fstrings.rb
+- lib/fstrings/formats.rb
+- lib/fstrings/parser.rb
+homepage: https://github.com/zverok/fstrings
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Python-alike fstrings (formatting strings) for Ruby
+test_files: []