rossoc 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c1044e8d160f0b6790e4bdf78ab4d638ed82e32cb50d3841946a5ac56110981
+  data.tar.gz: fe607e717eb85c61496d9b2727e26d3fa2f35afc503ced70164f22e032e9dc49
+SHA512:
+  metadata.gz: c28e9e8620c54f03803d9f44ca35809eaff57ba4b3d58864d514631f6455034ebf17d1735b55357e26399c6ef59b0bfaf7fee2e13fdc9dcf2d80d5d8c48f2bcf
+  data.tar.gz: e2a0cb26b8e45fa2ce99761431ef0c26c285a9918e3463cc577d1003fa90a59d38b593b0382aacd59af828928847d6f1b1a0f7c9d036d0017c73a0fc7639a1d8

data/.rubocop.yml

@@ -0,0 +1,21 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - vendor/bundle/**/*
+    - "lib/rossoc/parser.racc"
+    - "lib/rossoc/parser.racc.rb"
+    - "lib/rossoc/parser.rex"
+    - "lib/rossoc/parser.rex.rb"
+    - "lib/rossoc/sql_visitor.rb"
+    - "lib/rossoc/statement.rb"
+    - "rossoc.gemspec"
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Layout/LineLength:
+  Max: 150

data/.rubocop_todo.yml

@@ -0,0 +1,44 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-07-02 13:07:48 UTC using RuboCop version 1.63.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 40
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 118
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Offense count: 4
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 30
+
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
+Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 9
+
+# Offense count: 1
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/rossoc/backend.rb'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-04-19
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 arthur87
+
+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.base.md

@@ -0,0 +1,190 @@
+<!---------------------------->
+<!-- multilingual suffix: en, ja -->
+<!-- no suffix: en -->
+<!---------------------------->
+
+<!-- $ mmg README.base.md -->
+
+<!-- [ja] -->
+# rossoc
+rossoc はSQLからコードを生成する実験的なプロジェクトです。  
+SQLを mruby, mruby/c, と Arduino に変換します。 
+
+<!-- [en] -->
+# rossoc
+rossoc is an experimental project to generate code from sql.  
+Converts sql to mruby, mruby/c, or Arduino source code.
+
+<!-- [ja] -->
+# ガイド
+例えば、`SELECT din11 FROM mruby WHERE ((din1 = 0 AND din2 <= 1) OR din3 <> 9)` のようなSQLは以下のようなコードに変換されます。  
+
+<!-- [en] -->
+# Guide
+For example, SQL like `SELECT din11 FROM mruby WHERE ((din1 = 0 AND din2 <= 1) OR din3 <> 9)` is converted to source code like this:
+
+<!-- [common] -->
+```ruby
+# SELECT `din11` FROM `mruby` WHERE ((`din1` = 0 AND `din2` <= 1) OR `din3` <> 9)
+
+GPIO.setmode(11, GPIO::IN)
+GPIO.setmode(1, GPIO::IN)
+GPIO.setmode(2, GPIO::IN)
+GPIO.setmode(3, GPIO::IN)
+
+uart1 = UART.new(1)
+
+while 1 do
+  din11 = GPIO.read(11)
+  din1 = GPIO.read(1)
+  din2 = GPIO.read(2)
+  din3 = GPIO.read(3)
+
+  if ((din1 == 0 && din2 <= 1) || din3 != 9)
+    uart1.puts("din11=#{din11}")
+  end
+
+end
+```
+
+<!-- [ja] -->
+この mruby コードは次のコマンドで出力できます。  
+
+<!-- [en] -->
+This mruby code can be output with the following command.
+
+<!-- [common] -->
+```bash
+rossoc query -i 'SELECT din11 FROM mruby WHERE ((din1 = 0 AND din2 <= 1) OR din3 <> 9)' -o test.rb
+```
+
+<!-- [ja] -->
+`RSLEEP` は rossoc の独自キーワードです。 
+RSLEEPの単位は秒で、指定した秒数分、処理を停止します。
+
+<!-- [en] -->
+`RSLEEP` is the original keyword of rossoc. 
+RSLEEP is measured in seconds, and processing will be suspended for the specified number of seconds.
+
+<!-- [common] -->
+```bash
+rossoc query -i 'SELECT din11 FROM mruby WHERE ((din1 = 0 AND din2 <= 1) OR din3 <> 9) RSLEEP 100' -o test.rb
+```
+
+<!-- [ja] -->
+`RSLEEP` を使用したコードは以下のようになります。
+
+<!-- [en] -->
+The code will look like this.
+
+<!-- [common] -->
+```ruby
+# SELECT `din11` FROM `mruby` WHERE ((`din1` = 0 AND `din2` <= 1) OR `din3` <> 9) RSLEEP 100
+
+GPIO.setmode(11, GPIO::IN)
+GPIO.setmode(1, GPIO::IN)
+GPIO.setmode(2, GPIO::IN)
+GPIO.setmode(3, GPIO::IN)
+
+uart1 = UART.new(1)
+
+while 1 do
+  din11 = GPIO.read(11)
+  din1 = GPIO.read(1)
+  din2 = GPIO.read(2)
+  din3 = GPIO.read(3)
+
+  if ((din1 == 0 && din2 <= 1) || din3 != 9)
+    uart1.puts("din11=#{din11}")
+  end
+
+  sleep(100)
+
+end
+```
+
+```c
+// SELECT `din11` FROM `arduino` WHERE ((`din1` = 0 AND `din2` <= 1) OR `din3` <> 9) RSLEEP 100
+
+void setup() {
+  Serial.begin(9600);
+  
+  pinMode(11, INPUT);
+  pinMode(1, INPUT);
+  pinMode(2, INPUT);
+  pinMode(3, INPUT);
+}
+
+void loop() {
+  
+  int din11 = digitalRead(11);
+  int din1 = digitalRead(1);
+  int din2 = digitalRead(2);
+  int din3 = digitalRead(3);
+
+
+  if((din1 == 0 && din2 <= 1) || din3 != 9) {
+
+    Serial.print("din11=");
+    Serial.println(din11);
+
+  }
+
+  
+  delay(100000);
+  
+}
+```
+
+<!-- [ja] -->
+rossoc は `SELECT` ステートメントのみサポートしています。  
+カラムには `din1` から `din20` と `ain1` から `ain20` を指定できます。dinはデジタルピン、ainはアナログピンです。  
+テーブル名には `mruby`, `arduino` と `dev` が指定できます。
+もし `dev` を指定したときシンプルなrubyコードを出力します。 このコードは物理的なボードを必要としません。
+
+<!-- [en] -->
+rossoc is only `SELECT` statements are supported.  
+The values ​​that can be specified for the column name are `din1` to `din20` and `ain1` to `ain20`. din corresponds to digital pin, and ain corresponds to analog pin.  
+Possible values ​​for table name are `mruby`, `arduino` and `dev`.  
+If you specify `dev`, simple ruby ​​code will be output and you can run it immediately without a board.
+
+<!-- [ja] -->
+# 参考
+
+このプロジェクトでは以下の文献、コード等を参考にしています。  
+
+<!-- [en] -->
+# Reference
+
+<!-- [common] -->
+The following code is included to extend sql: https://github.com/cryodex/sql-parser  
+mruby, mruby/c Common I/O API Guidelines and Community-developed Libraries: https://github.com/mruby/microcontroller-peripheral-interface-guide
+
+<!-- [ja] -->
+# アーキテクチャ
+rossoc はフロントエンドとバックエンドから構成されています。
+独自のIR(中間表現)を介してフロントエンドとバックエンドを接続しています。  
+フロントエンドは、字句、構文、意味解析を実行します。
+バックエンドは、ターゲットのコードを生成します。
+
+<!-- [en] -->
+# Architecture
+rossoc is composed of a front-end and a back-end.  
+An original IR(Intermediate Representation) is used to connect the front-end and the back-end.  
+The front-end performs lexical, syntactic and semantic analysis.  
+The back-end generates code for the target.
+
+<!-- [common] -->
+```mermaid
+flowchart TB
+    input --> FrontEnd
+    subgraph FrontEnd
+    parser --> columns --> tables --> condition --> rsleep
+    end
+    FrontEnd --> IR --> BackEnd
+    subgraph BackEnd
+    generate
+    write
+    end
+    write --> output
+```

data/README.ja.md

@@ -0,0 +1,136 @@
+
+
+# rossoc
+rossoc はSQLからコードを生成する実験的なプロジェクトです。  
+SQLを mruby, mruby/c, と Arduino に変換します。 
+
+# ガイド
+例えば、`SELECT din11 FROM mruby WHERE ((din1 = 0 AND din2 <= 1) OR din3 <> 9)` のようなSQLは以下のようなコードに変換されます。  
+
+```ruby
+# SELECT `din11` FROM `mruby` WHERE ((`din1` = 0 AND `din2` <= 1) OR `din3` <> 9)
+
+GPIO.setmode(11, GPIO::IN)
+GPIO.setmode(1, GPIO::IN)
+GPIO.setmode(2, GPIO::IN)
+GPIO.setmode(3, GPIO::IN)
+
+uart1 = UART.new(1)
+
+while 1 do
+  din11 = GPIO.read(11)
+  din1 = GPIO.read(1)
+  din2 = GPIO.read(2)
+  din3 = GPIO.read(3)
+
+  if ((din1 == 0 && din2 <= 1) || din3 != 9)
+    uart1.puts("din11=#{din11}")
+  end
+
+end
+```
+
+この mruby コードは次のコマンドで出力できます。  
+
+```bash
+rossoc query -i 'SELECT din11 FROM mruby WHERE ((din1 = 0 AND din2 <= 1) OR din3 <> 9)' -o test.rb
+```
+
+`RSLEEP` は rossoc の独自キーワードです。 
+RSLEEPの単位は秒で、指定した秒数分、処理を停止します。
+
+```bash
+rossoc query -i 'SELECT din11 FROM mruby WHERE ((din1 = 0 AND din2 <= 1) OR din3 <> 9) RSLEEP 100' -o test.rb
+```
+
+`RSLEEP` を使用したコードは以下のようになります。
+
+```ruby
+# SELECT `din11` FROM `mruby` WHERE ((`din1` = 0 AND `din2` <= 1) OR `din3` <> 9) RSLEEP 100
+
+GPIO.setmode(11, GPIO::IN)
+GPIO.setmode(1, GPIO::IN)
+GPIO.setmode(2, GPIO::IN)
+GPIO.setmode(3, GPIO::IN)
+
+uart1 = UART.new(1)
+
+while 1 do
+  din11 = GPIO.read(11)
+  din1 = GPIO.read(1)
+  din2 = GPIO.read(2)
+  din3 = GPIO.read(3)
+
+  if ((din1 == 0 && din2 <= 1) || din3 != 9)
+    uart1.puts("din11=#{din11}")
+  end
+
+  sleep(100)
+
+end
+```
+
+```c
+// SELECT `din11` FROM `arduino` WHERE ((`din1` = 0 AND `din2` <= 1) OR `din3` <> 9) RSLEEP 100
+
+void setup() {
+  Serial.begin(9600);
+  
+  pinMode(11, INPUT);
+  pinMode(1, INPUT);
+  pinMode(2, INPUT);
+  pinMode(3, INPUT);
+}
+
+void loop() {
+  
+  int din11 = digitalRead(11);
+  int din1 = digitalRead(1);
+  int din2 = digitalRead(2);
+  int din3 = digitalRead(3);
+
+
+  if((din1 == 0 && din2 <= 1) || din3 != 9) {
+
+    Serial.print("din11=");
+    Serial.println(din11);
+
+  }
+
+  
+  delay(100000);
+  
+}
+```
+
+rossoc は `SELECT` ステートメントのみサポートしています。  
+カラムには `din1` から `din20` と `ain1` から `ain20` を指定できます。dinはデジタルピン、ainはアナログピンです。  
+テーブル名には `mruby`, `arduino` と `dev` が指定できます。
+もし `dev` を指定したときシンプルなrubyコードを出力します。 このコードは物理的なボードを必要としません。
+
+# 参考
+
+このプロジェクトでは以下の文献、コード等を参考にしています。  
+
+The following code is included to extend sql: https://github.com/cryodex/sql-parser  
+mruby, mruby/c Common I/O API Guidelines and Community-developed Libraries: https://github.com/mruby/microcontroller-peripheral-interface-guide
+
+# アーキテクチャ
+rossoc はフロントエンドとバックエンドから構成されています。
+独自のIR(中間表現)を介してフロントエンドとバックエンドを接続しています。  
+フロントエンドは、字句、構文、意味解析を実行します。
+バックエンドは、ターゲットのコードを生成します。
+
+```mermaid
+flowchart TB
+    input --> FrontEnd
+    subgraph FrontEnd
+    parser --> columns --> tables --> condition --> rsleep
+    end
+    FrontEnd --> IR --> BackEnd
+    subgraph BackEnd
+    generate
+    write
+    end
+    write --> output
+```

data/README.md

@@ -0,0 +1,134 @@
+
+
+# rossoc
+rossoc is an experimental project to generate code from sql.  
+Converts sql to mruby, mruby/c, or Arduino source code.
+
+# Guide
+For example, SQL like `SELECT din11 FROM mruby WHERE ((din1 = 0 AND din2 <= 1) OR din3 <> 9)` is converted to source code like this:
+
+```ruby
+# SELECT `din11` FROM `mruby` WHERE ((`din1` = 0 AND `din2` <= 1) OR `din3` <> 9)
+
+GPIO.setmode(11, GPIO::IN)
+GPIO.setmode(1, GPIO::IN)
+GPIO.setmode(2, GPIO::IN)
+GPIO.setmode(3, GPIO::IN)
+
+uart1 = UART.new(1)
+
+while 1 do
+  din11 = GPIO.read(11)
+  din1 = GPIO.read(1)
+  din2 = GPIO.read(2)
+  din3 = GPIO.read(3)
+
+  if ((din1 == 0 && din2 <= 1) || din3 != 9)
+    uart1.puts("din11=#{din11}")
+  end
+
+end
+```
+
+This mruby code can be output with the following command.
+
+```bash
+rossoc query -i 'SELECT din11 FROM mruby WHERE ((din1 = 0 AND din2 <= 1) OR din3 <> 9)' -o test.rb
+```
+
+`RSLEEP` is the original keyword of rossoc. 
+RSLEEP is measured in seconds, and processing will be suspended for the specified number of seconds.
+
+```bash
+rossoc query -i 'SELECT din11 FROM mruby WHERE ((din1 = 0 AND din2 <= 1) OR din3 <> 9) RSLEEP 100' -o test.rb
+```
+
+The code will look like this.
+
+```ruby
+# SELECT `din11` FROM `mruby` WHERE ((`din1` = 0 AND `din2` <= 1) OR `din3` <> 9) RSLEEP 100
+
+GPIO.setmode(11, GPIO::IN)
+GPIO.setmode(1, GPIO::IN)
+GPIO.setmode(2, GPIO::IN)
+GPIO.setmode(3, GPIO::IN)
+
+uart1 = UART.new(1)
+
+while 1 do
+  din11 = GPIO.read(11)
+  din1 = GPIO.read(1)
+  din2 = GPIO.read(2)
+  din3 = GPIO.read(3)
+
+  if ((din1 == 0 && din2 <= 1) || din3 != 9)
+    uart1.puts("din11=#{din11}")
+  end
+
+  sleep(100)
+
+end
+```
+
+```c
+// SELECT `din11` FROM `arduino` WHERE ((`din1` = 0 AND `din2` <= 1) OR `din3` <> 9) RSLEEP 100
+
+void setup() {
+  Serial.begin(9600);
+  
+  pinMode(11, INPUT);
+  pinMode(1, INPUT);
+  pinMode(2, INPUT);
+  pinMode(3, INPUT);
+}
+
+void loop() {
+  
+  int din11 = digitalRead(11);
+  int din1 = digitalRead(1);
+  int din2 = digitalRead(2);
+  int din3 = digitalRead(3);
+
+
+  if((din1 == 0 && din2 <= 1) || din3 != 9) {
+
+    Serial.print("din11=");
+    Serial.println(din11);
+
+  }
+
+  
+  delay(100000);
+  
+}
+```
+
+rossoc is only `SELECT` statements are supported.  
+The values ​​that can be specified for the column name are `din1` to `din20` and `ain1` to `ain20`. din corresponds to digital pin, and ain corresponds to analog pin.  
+Possible values ​​for table name are `mruby`, `arduino` and `dev`.  
+If you specify `dev`, simple ruby ​​code will be output and you can run it immediately without a board.
+
+# Reference
+
+The following code is included to extend sql: https://github.com/cryodex/sql-parser  
+mruby, mruby/c Common I/O API Guidelines and Community-developed Libraries: https://github.com/mruby/microcontroller-peripheral-interface-guide
+
+# Architecture
+rossoc is composed of a front-end and a back-end.  
+An original IR(Intermediate Representation) is used to connect the front-end and the back-end.  
+The front-end performs lexical, syntactic and semantic analysis.  
+The back-end generates code for the target.
+
+```mermaid
+flowchart TB
+    input --> FrontEnd
+    subgraph FrontEnd
+    parser --> columns --> tables --> condition --> rsleep
+    end
+    FrontEnd --> IR --> BackEnd
+    subgraph BackEnd
+    generate
+    write
+    end
+    write --> output
+```

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: %i[]
+
+PARSER = 'lib/rossoc/parser.racc'
+LEXER = 'lib/rossoc/parser.rex'
+
+task :parser do
+  system "rm #{PARSER}.rb #{LEXER}.rb"
+  system "racc -o #{PARSER}.rb #{PARSER}"
+  system "rex -o #{LEXER}.rb #{LEXER}"
+  system 'rspec'
+end

data/exe/rossoc

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rossoc'
+
+Rossoc::CLI.start

data/lib/rossoc/backend.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'rossoc'
+
+# Rossoc
+module Rossoc
+  # Backend
+  class Backend
+    class BackendError < StandardError; end
+
+    RESERVED_TABLES = %w[mruby arduino dev].freeze
+
+    def initialize(ir, output, overwrite_enable)
+      @ir = ir
+      @output = output
+      @content = nil
+      @overwrite_enable = overwrite_enable
+    end
+
+    def generate
+      table = @ir[:table]
+      raise BackendError, "unknown table value #{table}." if RESERVED_TABLES.index(table).nil?
+
+      template = ERB.new(
+        File.read("#{__dir__}#{File::SEPARATOR}views#{File::SEPARATOR}#{table}.erb"),
+        trim_mode: 2
+      )
+
+      @content = template.result_with_hash(@ir)
+    end
+
+    def write
+      raise BackendError, 'No content.' if @content.nil?
+
+      if @output.blank?
+        # ファイルが指定されていないとき標準出力
+        puts @content
+      else
+        raise BackendError, "File exists #{@output}." if File.exist?(@output) && !@overwrite_enable
+
+        file = File.open(@output, 'w')
+        file.write(@content)
+        file.close
+      end
+    end
+  end
+end

data/lib/rossoc/cli.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'rossoc'
+require 'thor'
+
+module Rossoc
+  # entry point
+  class CLI < Thor
+    class << self
+      def exit_on_failure?
+        true
+      end
+    end
+
+    desc 'version', 'Show Version'
+    def version
+      puts(Rossoc::VERSION)
+    end
+
+    desc 'query', 'Query'
+    method_option :input, desc: 'Input query', aliases: '-i'
+    method_option :output, desc: 'Write output to <file>', aliases: '-o'
+    method_option :ir, desc: 'Show IR Information', type: :boolean, default: false
+    method_option :yes, desc: 'Overwrite output file', type: :boolean, default: false, aliases: '-y'
+    def query
+      frontend = Rossoc::Frontend.new(options[:input].to_s)
+      begin
+        ir = frontend.ir
+      rescue StandardError => e
+        warn e.message
+        exit(1)
+      end
+
+      pp ir if options[:ir]
+
+      begin
+        backend = Rossoc::Backend.new(ir, options[:output].to_s, options[:yes])
+        backend.generate
+        backend.write
+      rescue StandardError => e
+        warn e.message
+        exit(1)
+      end
+    end
+  end
+end