aspen-cli 0.1.2

data/lib/aspen/renderers/cypher_batch_renderer.rb

@@ -0,0 +1,55 @@
+module Aspen
+  module Renderers
+    class CypherBatchRenderer < AbstractRenderer
+
+      # Sorts statements by signature, where signature could be
+      #   (Person)-[KNOWS]-(Person) or (Company)-[HIRED]->(Person).
+      def render
+        groups = statements.inject(
+          Hash.new { |h, k| h[k] = [] }
+          ) do |memo, statement|
+            memo[statement.signature] << statement
+            memo
+        end
+        groups.inject([]) do |memo, elem|
+          signature, statements = elem
+          if signature == "custom"
+            # Delegate custom statements to the base renderer
+            memo << CypherBaseRenderer.new(statements, environment).render
+          else
+            first = statements.first
+            values = statements.map do |statement|
+              "{from: #{statement.origin.attributes.values.first.inspect}, to: #{statement.target.attributes.values.first.inspect}}"
+            end.join(",\n  ")
+            memo << ERB.new(template).result_with_hash(
+              signature:    signature,
+              values:       values,
+              origin_label: first.origin.label,
+              target_label: first.target.label,
+              origin_attr:  first.origin.attributes.keys.first,
+              target_attr:  first.target.attributes.keys.first,
+              edge_cypher:  first.edge.to_cypher,
+            )
+          end
+          memo
+        end.join("\n\n")
+      end
+
+      def template
+        <<~TEMPLATE
+          // <%= signature %>
+
+          WITH [
+            <%= values %>
+          ] as values
+
+          UNWIND values as row
+          MERGE (from:<%= origin_label %> {<%= origin_attr %>: row.from})
+          MERGE (to:<%= target_label %> {<%= target_attr %>: row.to})
+          MERGE (from)<%= edge_cypher %>(to)
+        TEMPLATE
+      end
+
+    end
+  end
+end

data/lib/aspen/renderers/cypher_renderer.rb

@@ -0,0 +1,18 @@
+require 'aspen/renderers/cypher_base_renderer'
+require 'aspen/renderers/cypher_batch_renderer'
+
+module Aspen
+  module Renderers
+    class CypherRenderer < AbstractRenderer
+
+      def render
+        if environment[:batch].nil? || environment[:batch]
+          CypherBatchRenderer.new(statements).render
+        else
+          CypherBaseRenderer.new(statements).render
+        end
+      end
+
+    end
+  end
+end

data/lib/aspen/renderers/gexf_renderer.rb

@@ -0,0 +1,47 @@
+module Aspen
+  module Renderers
+    class GexfRenderer < AbstractRenderer
+
+      def render
+        joiner = "\n            "
+        <<~GEXF
+          <gexf xmlns="http://www.gexf.net/1.2draft" version="1.2">
+              <graph mode="static" defaultedgetype="directed">
+                  <nodes>
+                      #{nodes.map(&:strip).join(joiner)}
+                  </nodes>
+                  <edges>
+                      #{relationships.map(&:strip).join(joiner)}
+                  </edges>
+              </graph>
+          </gexf>
+        GEXF
+      end
+
+      def nodes
+        statements.flat_map(&:nodes).map do |node|
+          attrs = node.attributes.map do |k, v|
+            "#{k}=\"#{v}\""
+          end.join(" ")
+          <<~GEXF
+            <node id="#{node.nickname}" label="#{node.label}" #{attrs}>
+          GEXF
+        end
+      end
+
+      def relationships
+        # @todo: Add in Custom Statements
+        statements.map.with_index do |st, id|
+          if st.is_a? Aspen::CustomStatement
+            next # NO OP
+          else
+            <<~GEXF
+              <edge id="#{id}" source="#{st.origin.nickname}" target="#{st.target.nickname}" label="#{st.edge.label}">
+            GEXF
+          end
+        end.compact
+      end
+
+    end
+  end
+end

data/lib/aspen/renderers/json_renderer.rb

@@ -0,0 +1,40 @@
+module Aspen
+  module Renderers
+    class JsonRenderer < AbstractRenderer
+
+      def render
+        {
+          nodes: nodes,
+          edges: relationships
+        }.to_json
+      end
+
+      def nodes
+        statements.flat_map(&:nodes).map do |node|
+          node.attributes.merge({
+            id: node.nickname,
+            label: node.label
+          })
+        end
+      end
+
+      def relationships
+        statements.map.with_index do |st, id|
+          # @todo: Add in Custom Statements
+          if st.is_a? Aspen::CustomStatement
+            next # NO OP
+          else
+            {
+              id: "e#{id}",
+              source: st.origin.nickname,
+              target: st.target.nickname,
+              label: st.edge.label,
+              reciprocal: st.edge.reciprocal?
+            }
+          end
+        end.compact
+      end
+
+    end
+  end
+end

data/lib/aspen/renderers.rb

@@ -0,0 +1,9 @@
+module Aspen
+  module Renderers
+  end
+end
+
+require 'aspen/renderers/abstract_renderer'
+require 'aspen/renderers/cypher_renderer'
+require 'aspen/renderers/gexf_renderer'
+require 'aspen/renderers/json_renderer'

data/lib/aspen/schemas/discourse_schema.rb

@@ -0,0 +1,64 @@
+=begin
+
+  Example:
+
+  default:
+    label:     Person
+    attribute: name (text)
+    attributes:
+      Event:   title (text)
+      Company: year_founded (number)
+
+  only:
+    nodes: Person, Company
+    relationships: knows, works for
+
+  reciprocal: knows
+
+  grammar:
+    -
+      match: (Person a) knows (Person b).
+      template: {{{a}}}-[:KNOWS]->{{{b}}}.
+
+=end
+
+require 'dry/schema'
+require 'aspen/schemas/grammar_schema'
+
+module Aspen
+  module Schemas
+
+    LABEL      = /^([A-Z][A-Za-z0-9]+)+$/
+    LABEL_LIST = /^([A-Z][A-Za-z0-9]+)(,\s*([A-Z][A-Za-z0-9]+))*$/
+    EDGE_LIST  = /^([A-Za-z\s]+)(,\s*[A-Za-z\s]+)*$/
+    IDENT      = /^[A-Za-z]\w*$/
+    IDENT_LIST = /^(\w+)(,\s*\w+)*$/
+
+    DiscourseSchema = Dry::Schema.Params do
+      # config.validate_keys = true
+
+      optional(:adapter)
+
+      optional(:default).hash do
+        optional(:label).filled(:string, format?: LABEL)
+        optional(:attribute).filled(:string, format?: IDENT)
+        optional(:attributes).filled(:hash) # TODO Validate hash
+      end
+
+      optional(:allow_only).hash do
+        optional(:nodes).filled
+        optional(:edges).filled
+      end
+
+      # TODO Validate that there are no reciprocal relationships
+      # not listed in `only`
+      # Is there a way to do something like:
+      #   included_in?: [ self.only ] if self.only
+      # Yes! If we make this a validation!
+      optional(:reciprocal).filled(:string, format?: EDGE_LIST)
+
+      optional(:grammar).array(GrammarSchema)
+    end
+
+  end
+end

data/lib/aspen/schemas/grammar_schema.rb

@@ -0,0 +1,24 @@
+require 'dry/schema'
+
+=begin
+
+  grammar:
+    -
+      match:
+        - (Person a) knows (Person b).
+      template: {{{a}}}-[:KNOWS]->{{{b}}}.
+
+=end
+
+module Aspen
+  module Schemas
+
+    GrammarSchema = Dry::Schema.Params do
+      config.validate_keys = true
+
+      required(:match).array(:str?)
+      required(:template).filled(:string)
+    end
+
+  end
+end

data/lib/aspen/statement.rb

@@ -0,0 +1,42 @@
+require 'aspen/abstract_statement'
+
+module Aspen
+  class Statement < AbstractStatement
+
+    attr_reader :origin, :edge, :target, :type
+
+    def type
+      :vanilla
+    end
+
+    def signature
+      [
+        origin.signature,
+        edge.signature,
+        target.signature
+      ].join()
+    end
+
+    # @param origin [Aspen::Node]
+    # @param edge [Aspen::Edge]
+    # @param target [Aspen::Node]
+    def initialize(origin: , edge: , target: )
+      @origin      = origin
+      @edge        = edge
+      @target = target
+    end
+
+    def nodes
+      [origin, target]
+    end
+
+    def to_cypher
+      [
+        origin.nickname_node,
+        edge.to_cypher,
+        target.nickname_node
+      ].join('')
+    end
+
+  end
+end

data/lib/aspen/system_default.rb

@@ -0,0 +1,12 @@
+module Aspen
+  module SystemDefault
+
+    def self.label
+      "Entity".freeze
+    end
+
+    def self.attr_name
+      "name".freeze
+    end
+  end
+end

data/lib/aspen/version.rb

@@ -0,0 +1,3 @@
+module Aspen
+  VERSION = "0.1.2"
+end

data/lib/aspen.rb

@@ -0,0 +1,65 @@
+require 'aspen/abstract_parser'
+require 'aspen/abstract_statement'
+require 'aspen/adapters'
+require 'aspen/ast'
+require 'aspen/compiler'
+require 'aspen/contracts'
+require 'aspen/custom_grammar'
+require 'aspen/custom_statement'
+require 'aspen/discourse'
+require 'aspen/edge'
+require 'aspen/errors'
+require 'aspen/lexer'
+require 'aspen/node'
+require 'aspen/parser'
+require 'aspen/renderers'
+require 'aspen/statement'
+require 'aspen/system_default'
+require 'aspen/version'
+
+module Aspen
+
+  @@available_formats = []
+
+  def self.available_formats
+    @@available_formats
+  end
+
+  def self.available_formats=(*args)
+    @@available_formats = Array(args).flatten
+  end
+
+  # Set the available formats for the compiler.
+  Aspen::Adapters::Registry.new
+
+  # TODO: There wants to be a pre-compiler stage/object.
+
+  SEPARATOR = "----".freeze
+
+  def self.compile_code(code, environment = {})
+    tokens = Lexer.tokenize(code, environment)
+    ast = Parser.parse(tokens, environment)
+    Compiler.render(ast, environment)
+  end
+
+  def self.compile_text(text, environment = {})
+    assert_text(text)
+
+    if text.include?(SEPARATOR)
+      env, _sep, code = text.partition(SEPARATOR)
+      compile_code(code, YAML.load(env).merge(environment))
+    else
+      code = text
+      compile_code(code, environment)
+    end
+  end
+
+  private
+
+  def self.assert_text(text)
+    if text.strip.empty?
+      raise Aspen::Error, "Text must be provided to the `Aspen.compile_text` method."
+    end
+  end
+
+end

metadata

@@ -0,0 +1,300 @@
+--- !ruby/object:Gem::Specification
+name: aspen-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Matt Cloyd
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: airtable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: neo4j-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 9.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 9.0.0
+description: "\n    Aspen is a simple markup language that renders into Cypher. Write
+  narrative data,\n    mark it up, and compile to Cypher.\n  "
+email:
+- cloyd.matt@gmail.com
+executables:
+- aspen
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/FUNDING.yml"
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- aspen.gemspec
+- bin/aspen
+- bin/console
+- bin/setup
+- lib/aspen.rb
+- lib/aspen/abstract_parser.rb
+- lib/aspen/abstract_statement.rb
+- lib/aspen/actions.rb
+- lib/aspen/actions/compile.rb
+- lib/aspen/actions/push.rb
+- lib/aspen/actions/watch.rb
+- lib/aspen/adapters.rb
+- lib/aspen/ast.rb
+- lib/aspen/ast/nodes/attribute.rb
+- lib/aspen/ast/nodes/comment.rb
+- lib/aspen/ast/nodes/content.rb
+- lib/aspen/ast/nodes/custom_statement.rb
+- lib/aspen/ast/nodes/edge.rb
+- lib/aspen/ast/nodes/label.rb
+- lib/aspen/ast/nodes/narrative.rb
+- lib/aspen/ast/nodes/node.rb
+- lib/aspen/ast/nodes/statement.rb
+- lib/aspen/ast/nodes/type.rb
+- lib/aspen/cli.rb
+- lib/aspen/cli/commands.rb
+- lib/aspen/cli/commands/build.rb
+- lib/aspen/cli/commands/build_steps.rb
+- lib/aspen/cli/commands/compile.rb
+- lib/aspen/cli/commands/generate.rb
+- lib/aspen/cli/commands/new.rb
+- lib/aspen/cli/commands/push.rb
+- lib/aspen/cli/commands/version.rb
+- lib/aspen/cli/commands/watch.rb
+- lib/aspen/cli/templates/.gitignore
+- lib/aspen/cli/templates/airtable.yml
+- lib/aspen/cli/templates/convert
+- lib/aspen/cli/templates/db.yml.erb
+- lib/aspen/cli/templates/docker-compose.yml
+- lib/aspen/cli/templates/manifest.yml.erb
+- lib/aspen/compiler.rb
+- lib/aspen/contracts.rb
+- lib/aspen/contracts/default_attribute_contract.rb
+- lib/aspen/conversion.rb
+- lib/aspen/custom_grammar.rb
+- lib/aspen/custom_grammar/ast.rb
+- lib/aspen/custom_grammar/ast/nodes/bare.rb
+- lib/aspen/custom_grammar/ast/nodes/capture_segment.rb
+- lib/aspen/custom_grammar/ast/nodes/content.rb
+- lib/aspen/custom_grammar/ast/nodes/expression.rb
+- lib/aspen/custom_grammar/compiler.rb
+- lib/aspen/custom_grammar/grammar.rb
+- lib/aspen/custom_grammar/lexer.rb
+- lib/aspen/custom_grammar/matcher.rb
+- lib/aspen/custom_grammar/parser.rb
+- lib/aspen/custom_statement.rb
+- lib/aspen/discourse.rb
+- lib/aspen/edge.rb
+- lib/aspen/errors.rb
+- lib/aspen/helpers.rb
+- lib/aspen/lexer.rb
+- lib/aspen/list.rb
+- lib/aspen/node.rb
+- lib/aspen/parser.rb
+- lib/aspen/renderers.rb
+- lib/aspen/renderers/abstract_renderer.rb
+- lib/aspen/renderers/cypher_base_renderer.rb
+- lib/aspen/renderers/cypher_batch_renderer.rb
+- lib/aspen/renderers/cypher_renderer.rb
+- lib/aspen/renderers/gexf_renderer.rb
+- lib/aspen/renderers/json_renderer.rb
+- lib/aspen/schemas/discourse_schema.rb
+- lib/aspen/schemas/grammar_schema.rb
+- lib/aspen/statement.rb
+- lib/aspen/system_default.rb
+- lib/aspen/version.rb
+homepage: https://github.com/beechnut/aspen
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/beechnut/aspen
+  source_code_uri: https://github.com/beechnut/aspen
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Aspen turns simple text into graph data, compiling it into Cypher for Neo4j
+  graph databases.
+test_files: []