natural_dsl 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97856ddab791034315f5feac6ec0bb5648299d2374d2130b49f6601d315a710e
+  data.tar.gz: 1f1fa4301a53ab7cedbad37cd68ebde01fd77df24fedbb033e30e632a8d5e6ac
+SHA512:
+  metadata.gz: 03ead22cfb4c3d7020778bfad056a02c00fc3954a8f99450be770c4bfa79b7344459988bd62037eecac5250921be89afebe2ffb6a1095fb8459e204e846a951b
+  data.tar.gz: 3cb2097e3e5bbf7df1e51cc508978ea5f3a313b161bb23f6aa4a543792f3651f466c0e42a91aa0debc2c22406bd20b9a9ec5710fae7105ad1c0526b115eb5ed7

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Change log
+
+## main
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 DmitryTsepelev
+
+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,50 @@
+# NaturalDSL
+
+An experimental (and highly likely useless for real–world) *DSL to build a natural–ish DSL language* and write your programs using it. Right to the example:
+
+```ruby
+lang = NaturalDSL::Lang.define do
+  command :route do
+    keyword :from
+    token
+    keyword :to
+    token
+    value :takes
+
+    execute do |vm, city1, city2, distance|
+      distances = vm.read_variable(:distances) || {}
+      distances[[city1, city2]] = distance
+      vm.assign_variable(:distances, distances)
+    end
+  end
+
+  command :how do
+    keyword :long
+    keyword :will
+    keyword :it
+    keyword :take
+    keyword :to
+    keyword :get
+    keyword :from
+    token
+    keyword :to
+    token
+
+    execute do |vm, city1, city2|
+      distances = vm.read_variable(:distances) || {}
+      distance = distances[[city1, city2]].value
+      "Travel from #{city1.name} to #{city2.name} takes #{distance} hours"
+    end
+  end
+end
+
+result = NaturalDSL::VM.run(lang) do
+  route from london to glasgow takes 22
+  route from paris to prague takes 12
+  how long will it take to get from london to glasgow
+end
+
+puts result # => Travel from london to glasgow takes 22 hours
+```
+
+Read more about this experiment in by [blog](https://dmitrytsepelev.dev/natural-language-programming-with-ruby).

data/lib/natural_dsl/command.rb

@@ -0,0 +1,50 @@
+require "natural_dsl/command_runner"
+
+module NaturalDSL
+  class Command
+    def self.build(command_name, &block)
+      new(command_name).build(&block)
+    end
+
+    attr_reader :name, :execution_block
+
+    def initialize(name)
+      @name = name
+    end
+
+    def build(&block)
+      tap { |command| command.instance_eval(&block) }
+    end
+
+    def run(vm)
+      CommandRunner.new(self, vm).run
+    end
+
+    def expectations
+      @expectations ||= []
+    end
+
+    def value_method_names
+      @value_method_names ||= []
+    end
+
+    private
+
+    def token
+      expectations << Primitives::Token
+    end
+
+    def value(method_name = :value)
+      value_method_names << method_name
+      expectations << Primitives::Value
+    end
+
+    def keyword(type)
+      expectations << Primitives::Keyword.new(type)
+    end
+
+    def execute(&block)
+      @execution_block = block
+    end
+  end
+end

data/lib/natural_dsl/command_runner.rb

@@ -0,0 +1,38 @@
+require "refinements/string_demodulize"
+
+module NaturalDSL
+  class CommandRunner
+    using StringDemodulize
+
+    class StackNotEmpty < RuntimeError; end
+
+    def initialize(command, vm)
+      @command = command
+      @vm = vm
+    end
+
+    def run
+      args = @command.expectations.each_with_object([], &method(:check_expectation))
+
+      raise_stack_not_empty_error if @vm.stack.any?
+
+      @command.execution_block.call(@vm, *args)
+    end
+
+    private
+
+    def check_expectation(expectation, args)
+      if expectation.is_a?(Primitives::Keyword)
+        @vm.stack.pop_if_keyword(expectation.type)
+      else
+        args << @vm.stack.pop_if(expectation)
+      end
+    end
+
+    def raise_stack_not_empty_error
+      class_names = @vm.stack.map { |primitive| primitive.class.name.demodulize }
+
+      raise StackNotEmpty, "unexpected #{class_names.join(" ")} after #{@command.name}"
+    end
+  end
+end

data/lib/natural_dsl/lang.rb

@@ -0,0 +1,38 @@
+require "natural_dsl/command"
+
+module NaturalDSL
+  class Lang
+    def self.define(&block)
+      new.tap { |lang| lang.instance_eval(&block) }
+    end
+
+    def command(command_name, &block)
+      command = Command.build(command_name, &block)
+      register_keywords(command)
+      commands[command_name] = command
+    end
+
+    def keywords
+      @keywords ||= []
+    end
+
+    def commands
+      @commands ||= {}
+    end
+
+    private
+
+    def register_keywords(command)
+      command.expectations.filter(&method(:keyword?)).each(&method(:register_keyword))
+    end
+
+    def keyword?(expectation)
+      expectation.is_a?(Primitives::Keyword)
+    end
+
+    def register_keyword(keyword)
+      return if keywords.include?(keyword.type)
+      keywords << keyword.type
+    end
+  end
+end

data/lib/natural_dsl/primitives.rb

@@ -0,0 +1,21 @@
+module NaturalDSL
+  module Primitives
+    Value = Struct.new(:value) do
+      def inspect
+        "Value(#{value})"
+      end
+    end
+
+    Token = Struct.new(:name) do
+      def inspect
+        "Token(#{name})"
+      end
+    end
+
+    Keyword = Struct.new(:type) do
+      def inspect
+        "Keyword(#{type})"
+      end
+    end
+  end
+end

data/lib/natural_dsl/stack.rb

@@ -0,0 +1,21 @@
+module NaturalDSL
+  class Stack < Array
+    using StringDemodulize
+
+    def pop_if(expected_class)
+      return pop if last.is_a?(expected_class)
+
+      error_reason = empty? ? "stack was empty" : "got #{last.class.name.demodulize}"
+      raise "Expected #{expected_class.name.demodulize} but #{error_reason}"
+    end
+
+    def pop_if_keyword(keyword_type)
+      pop_if(Primitives::Keyword).tap do |keyword|
+        next if keyword.type == keyword_type
+
+        push(keyword)
+        raise "Expected #{keyword_type} but got #{keyword.type}"
+      end
+    end
+  end
+end

data/lib/natural_dsl/version.rb

@@ -0,0 +1,3 @@
+module NaturalDSL
+  VERSION = "0.0.2"
+end

data/lib/natural_dsl/vm.rb

@@ -0,0 +1,65 @@
+require "natural_dsl/stack"
+
+module NaturalDSL
+  class VM
+    class << self
+      def build(lang)
+        lang.commands.each do |command_name, command|
+          define_command(lang, command_name, command)
+        end
+
+        new(lang)
+      end
+
+      def run(lang, &block)
+        build(lang).run(&block)
+      end
+
+      private
+
+      def define_command(lang, command_name, command)
+        define_method(command_name) { |*| command.run(self) }
+
+        command.value_method_names.each do |value_method_name|
+          define_method(value_method_name) do |value|
+            @stack << NaturalDSL::Primitives::Value.new(value)
+          end
+        end
+      end
+    end
+
+    attr_reader :variables, :stack
+
+    def initialize(lang)
+      @lang = lang
+      @variables = {}
+      @stack = NaturalDSL::Stack.new
+    end
+
+    def run(&block)
+      instance_eval(&block)
+    end
+
+    def assign_variable(token, value)
+      @variables[token.name] = value
+    end
+
+    def read_variable(token)
+      @variables[token.name]
+    end
+
+    def method_missing(unknown, *args, &block)
+      klass = if @lang.keywords.include?(unknown)
+        NaturalDSL::Primitives::Keyword
+      else
+        NaturalDSL::Primitives::Token
+      end
+
+      @stack << klass.new(unknown)
+    end
+
+    def respond_to_missing?(*)
+      true
+    end
+  end
+end

data/lib/natural_dsl.rb

@@ -0,0 +1,7 @@
+require "natural_dsl/primitives"
+require "natural_dsl/lang"
+require "natural_dsl/vm"
+require "natural_dsl/version"
+
+module NaturalDSL
+end

data/lib/refinements/string_demodulize.rb

@@ -0,0 +1,7 @@
+module StringDemodulize
+  refine String do
+    def demodulize
+      split("::").last
+    end
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: natural_dsl
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- DmitryTsepelev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-07-26 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- dmitry.a.tsepelev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/natural_dsl.rb
+- lib/natural_dsl/command.rb
+- lib/natural_dsl/command_runner.rb
+- lib/natural_dsl/lang.rb
+- lib/natural_dsl/primitives.rb
+- lib/natural_dsl/stack.rb
+- lib/natural_dsl/version.rb
+- lib/natural_dsl/vm.rb
+- lib/refinements/string_demodulize.rb
+homepage: https://github.com/DmitryTsepelev/natural_dsl
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/DmitryTsepelev/natural_dsl/issues
+  changelog_uri: https://github.com/DmitryTsepelev/natural_dsl/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/DmitryTsepelev/natural_dsl/blob/master/README.md
+  homepage_uri: https://github.com/DmitryTsepelev/natural_dsl
+  source_code_uri: https://github.com/DmitryTsepelev/natural_dsl
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: An experiment of building natural language DSLs in Ruby
+test_files: []