aspen-cli 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 400c18c8445558b854ce7a15ba4d21918f65fbc63830a3f28146b67af00ec296
+  data.tar.gz: f2f6d60d7b1ca2cdfb8d5ade61121d6cae332ad793d792a818ef3dc8b0f16008
+SHA512:
+  metadata.gz: e6449be7bff4bf4e28f50e79a6783b56f1b59000c87c767a421777e8fabd2df866f7da9a02ed89aae6cbb9be10251d9d940d4b55c88e73b5398bb98d6d303816
+  data.tar.gz: c496e65c4b94e523bb294a35478933787582f0177c0303b729f4bf4fdab62bd5216ebfbe36c9ae3ce44f96161aae8ce6284a0dbd954238a1109f065f5f9ca4dc

data/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [beechnut]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/vendor/
+/examples/
+
+.DS_Store
+
+# Ignore sample project
+myproject/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at cloyd.matt@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in aspen.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "dry-schema",  github: "beechnut/dry-schema", ref: "fix-array-validation"

data/Gemfile.lock

@@ -0,0 +1,175 @@
+GIT
+  remote: https://github.com/beechnut/dry-schema.git
+  revision: 5192d5e7c4d21406ad087a992049ab9fb24ac6fa
+  ref: fix-array-validation
+  specs:
+    dry-schema (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.8, >= 0.8.3)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 3.0)
+      dry-logic (~> 1.0)
+      dry-types (~> 1.4)
+
+PATH
+  remote: .
+  specs:
+    aspen-cli (0.1.0)
+      activesupport (~> 6.0)
+      airtable (~> 0.0)
+      dry-cli (= 0.6.0)
+      dry-container (~> 0.7)
+      dry-monads (~> 1.0)
+      dry-types (~> 1.0)
+      dry-validation (= 1.5.0)
+      listen (~> 3.0)
+      mustache (~> 1.0)
+      neo4j-core (= 9.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    airtable (0.0.9)
+      httparty
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    dry-cli (0.6.0)
+      concurrent-ruby (~> 1.0)
+    dry-configurable (0.11.5)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+      dry-equalizer (~> 0.2)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-initializer (3.0.3)
+    dry-logic (1.0.6)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-monads (1.3.5)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer
+    dry-types (1.4.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    dry-validation (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.7, >= 0.7.1)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 3.0)
+      dry-schema (~> 1.5)
+    ethon (0.14.0)
+      ffi (>= 1.15.0)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday_middleware (1.1.0)
+      faraday (~> 1.0)
+    faraday_middleware-multi_json (0.0.6)
+      faraday_middleware
+      multi_json
+    ffi (1.15.4)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    httpclient (2.8.3)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    json (2.5.1)
+    listen (3.7.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    method_source (0.9.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0901)
+    minitest (5.14.4)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    mustache (1.1.1)
+    neo4j-core (9.0.0)
+      activesupport (>= 4.0)
+      faraday (>= 0.9.0)
+      faraday_middleware (>= 0.10.0)
+      faraday_middleware-multi_json
+      httpclient
+      json
+      multi_json
+      net_tcp_client (>= 2.0.1)
+      typhoeus (>= 1.1.2)
+    net_tcp_client (2.2.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.3.3)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    ruby2_keywords (0.0.5)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aspen-cli!
+  dry-schema!
+  pry (~> 0.12)
+  rake (~> 12.0)
+  rspec (~> 3.2)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Matthew J Cloyd
+
+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,84 @@
+# Aspen
+
+Aspen is a simple markup language that transforms simple narrative information into rich graph data for use in Neo4j.
+
+To put it another way, Aspen transforms narrative text to Cypher, specifically for use in creating graph data.
+
+In short, Aspen transforms this:
+
+```aspen
+(Liz) [knows] (Jack)
+```
+
+into (roughly) this
+
+```cypher
+MERGE (:Entity { name: "Liz" })-[:KNOWS]->(:Entity { name: "Jack" })
+```
+
+and can push it to a Neo4j database.
+
+Want Liz and Jack to be nodes with a `:Person` label? Just add a little config.
+
+```aspen
+default:
+  label: Person
+----
+(Liz) [knows] (Jack)
+```
+
+```aspen
+MERGE (:Person { name: "Liz" })-[:KNOWS]->(:Person { name: "Jack" })
+```
+
+
+### Installation
+
+```
+$ gem install aspen-cli
+```
+
+Start a new project:
+
+```
+$ aspen new your_project_name_here
+```
+
+### Documentation
+
+[Quickstart Guide](https://github.com/thepeergroup/aspen/wiki/Quickstart-Guide)
+
+[Full documentation in the Wiki](https://github.com/thepeergroup/aspen/wiki)
+
+
+### Why use Aspen?
+
+You need to turn notes and narratives into a network diagram or graph data.
+
+You may also want to connect that data to other data, maybe graph data, maybe tabular data.
+
+For what you want:
+
+- Spreadsheets are too rigid,
+- Machine learning and Natural Language Processing (NLP) are out of reach, and
+- You're ok using command-line tools for now (we hope to offer a GUI soon)
+
+
+## Code of Conduct
+
+We expect that anyone working on this project will be good and kind to each other. We're developing software about relationships, and anyone who works on this project is expected to have healthy relating skills.
+
+Everyone interacting in the Aspen project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/beechnut/aspen/blob/master/CODE_OF_CONDUCT.md).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/beechnut/aspen. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/beechnut/aspen/blob/master/CODE_OF_CONDUCT.md).
+
+If you'd like to see Aspen grow, please [get in touch](https://github.com/thepeergroup/aspen/discussions), whether you're a developer, user, or potential sponsor. We have ideas on ways to grow Aspen, and we need your help to do so, whatever form that help takes.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/aspen.gemspec

@@ -0,0 +1,48 @@
+require_relative 'lib/aspen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aspen-cli"
+  spec.version       = Aspen::VERSION
+  spec.authors       = ["Matt Cloyd"]
+  spec.email         = ["cloyd.matt@gmail.com"]
+
+  spec.summary       = %q{
+    Aspen turns simple text into graph data, compiling it into Cypher for Neo4j graph databases.
+  }
+  spec.description   = %q{
+    Aspen is a simple markup language that renders into Cypher. Write narrative data,
+    mark it up, and compile to Cypher.
+  }
+  spec.homepage      = "https://github.com/beechnut/aspen"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/aspen}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "pry",   "~> 0.12"
+
+  spec.add_dependency "activesupport",  "~> 6.0"
+  spec.add_dependency "airtable",       "~> 0.0"
+  spec.add_dependency "dry-cli",           "0.6.0"
+  spec.add_dependency "dry-container",  "~> 0.7"
+  spec.add_dependency "dry-monads",     "~> 1.0"
+  spec.add_dependency "dry-validation",    "1.5.0"
+  spec.add_dependency "dry-types",      "~> 1.0"
+  spec.add_dependency "listen",         "~> 3.0"
+  spec.add_dependency "mustache",       "~> 1.0"
+  spec.add_dependency "neo4j-core",        "9.0.0"
+end

data/bin/aspen

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'aspen/cli'
+Dry::CLI.new(Aspen::CLI::Commands).call

data/bin/console

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+ENV['DEBUG'] = "true"
+
+require "bundler/setup"
+require "aspen"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+@code = "(Liz) [works at] (Employer, NBC)."
+@tokens = Aspen::Lexer.tokenize(@code)
+@ast = Aspen::Parser.parse(@tokens)
+@compiler = Aspen::Compiler.new(@ast, {})
+
+def go
+  @compiler.render
+end
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/aspen/abstract_parser.rb

@@ -0,0 +1,72 @@
+module Aspen
+  class AbstractParser
+
+    def self.parse(tokens, env={})
+      new(tokens).parse
+    end
+
+    # Convenience method
+    def self.parse_code(code, env={}, lexer=Aspen::Lexer)
+      tokens = lexer.tokenize(code, env)
+      parse(tokens, env)
+    end
+
+    attr_reader :tokens, :position
+
+    def initialize(tokens, env={})
+      @tokens = tokens
+      # Nothing is done with environment in the parser.
+      # Calling #next will start at 0
+      @position = 0
+    end
+
+    def expect(*expected_tokens)
+      upcoming = tokens[position, expected_tokens.size]
+
+      if upcoming.map(&:first) == expected_tokens
+        advance_by expected_tokens.size
+        upcoming
+      end
+    end
+
+    def need(*required_tokens)
+      upcoming = tokens[position, required_tokens.size]
+      expect(*required_tokens) or raise Aspen::ParseError, <<~ERROR
+        Unexpected tokens. Expected #{required_tokens.inspect} but got #{upcoming.inspect}
+      ERROR
+    end
+
+    def first
+      tokens.first
+    end
+
+    def last
+      tokens.last
+    end
+
+    def next_token
+      t = tokens[position]
+      advance
+      return t
+    end
+
+    def peek(offset = 0)
+      if offset > 0
+        tokens[position + 1..position + offset]
+      else
+        tokens[position]
+      end
+    end
+
+    private
+
+    def advance
+      advance_by 1
+    end
+
+    def advance_by(offset = 1)
+      @position += offset
+    end
+
+  end
+end

data/lib/aspen/abstract_statement.rb

@@ -0,0 +1,34 @@
+module Aspen
+  class AbstractStatement
+
+    # In the abstract, Statements must:
+    #   - return nodes ([Aspen::Node])
+    #   - return a Cypher representation of an object (String)
+    #   - report their type (custom, vanilla, etc.)
+
+    # @return [String] the type of statement (:vanilla, :custom)
+    def type
+      raise NotImplementedError, "Find me in #{__FILE__}"
+    end
+
+    # @return [String] a short description the relationship contained in the statement
+    # @example Company hired a Person
+    #   (Company)-[HIRED]->(Person)
+    # @example Person knows Person, reciprocally
+    #   (Person)-[KNOWS]-(Person)
+    def signature
+      raise NotImplementedError, "Find me in #{__FILE__}"
+    end
+
+    # @return [Array<Aspen::Node>] a list of nodes from the statement
+    def nodes
+      raise NotImplementedError, "Find me in #{__FILE__}"
+    end
+
+    # @return [String] the Cypher query from this particular statement
+    def to_cypher
+      raise NotImplementedError, "Find me in #{__FILE__}"
+    end
+
+  end
+end

data/lib/aspen/actions/compile.rb

@@ -0,0 +1,31 @@
+module Aspen
+  module Actions
+    class Compile
+
+      attr_reader :options
+
+      def initialize(path, options = {})
+        @path = path
+        @basename = File.basename(@path, ".aspen")
+        dir       = File.dirname(@path)
+        @dest     = File.expand_path("#{@basename}.cql", dir)
+        @options  = options
+      end
+
+      def call
+        compile_to_file
+        send_to_database if options.fetch(:database, false)
+      end
+
+      private
+
+      def compile_to_file
+        @cypher ||= Aspen.compile_text(File.read(@path))
+        File.open(@dest, 'w') { |file| file << @cypher }
+        puts "Compiled #{@basename}.aspen to #{@basename}.cql."
+      end
+
+    end
+  end
+end
+

data/lib/aspen/actions/push.rb

@@ -0,0 +1,39 @@
+require 'neo4j/core'
+require 'neo4j/core/cypher_session/adaptors/http'
+
+module Aspen
+  module Actions
+    class Push
+
+      def initialize(path: nil, config_path: 'config/db.yml')
+        @path_to_cql = path || Dir["build/main-*.cql"].first
+        config = YAML::load_file(config_path)
+        url = config.fetch("url").strip
+        adapter = Neo4j::Core::CypherSession::Adaptors::HTTP.new(url, {})
+        @session = Neo4j::Core::CypherSession.new(adapter)
+      rescue => e
+        puts e.message
+        puts e.backtrace
+      end
+
+      def call
+        drop
+        push
+      end
+
+      def drop
+        print "Dropping data from database..."
+        @session.query("MATCH (n) DETACH DELETE n")
+        print "OK\n"
+      end
+
+      def push
+        file = File.read(@path_to_cql)
+        print "Pushing data to database from #{@path_to_cql}..."
+        @session.query(file)
+        print "OK\n"
+      end
+
+    end
+  end
+end