meta_commit_contracts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1c30cbfd78f28d2713316f26cfcce07fb472d72
+  data.tar.gz: 4d616142b91ce7730557d924aa515a41e8b9c036
+SHA512:
+  metadata.gz: 6bf715451183e9a900e54db8b37eb4364af814248fb673860eaaa5f8a1241412ba44fce16975ec5f07a920a7bcbc91b9e828b980b5b0108f1b0c1f8e0a4c5798
+  data.tar.gz: 084b31f3f20e6da868d8287c65ef3a62be130df52e9255eaa17f9a2209603c6a33eac4896a696b2f34ca73b42363844c3d71965c6ac893634a5f2ab243cd665e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

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 stasdobrovolskiy@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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in meta_commit_contracts.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Stanislav Dobrovolskiy
+
+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,49 @@
+# meta commit contracts
+[![Gem Version](https://badge.fury.io/rb/meta_commit_contracts.svg)](https://badge.fury.io/rb/meta_commit)
+
+## Description
+
+gem includes agreements on data structures, which used by [meta commit gem](https://github.com/usernam3/meta_commit) to interact with extensions
+Contracts make extension development transparent and 
+
+Contracts (and their responsibilities) :
+
+-   Ast
+    -   stores information about which parser built it
+    -   stores abstract syntax tree
+    -   provides access to children nodes
+    -   provides access to first line number and last line number
+-   Parser
+    -   builds ast node from code string
+    -   knows about file extensions he supports
+    -   knows about syntax he supports
+-   ContextualAst
+    -   stores information about which parser built target ast
+    -   stores target ast and all nodes
+-   Diff
+    -   builds human-readable message of change 
+    -   knows what changes it can be used for 
+-   Locator
+    -   locates exported classes of extension
+
+You can check documentation [here]()
+
+##  Installation
+ 
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'meta_commit_contracts'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install meta_commit_contracts
+
+##  Usage
+
+Inherit components of extension from these classes and override appropriate methods

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "meta_commit_contracts"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/meta_commit_contracts.rb

@@ -0,0 +1,12 @@
+module MetaCommit
+  module Contracts
+  end
+end
+
+require "meta_commit_contracts/version"
+require "meta_commit_contracts/ast"
+require "meta_commit_contracts/contextual_ast"
+require "meta_commit_contracts/diff"
+require "meta_commit_contracts/errors"
+require "meta_commit_contracts/locator"
+require "meta_commit_contracts/parser"

data/lib/meta_commit_contracts/ast.rb

@@ -0,0 +1,23 @@
+module MetaCommit::Contracts
+  # Structure which is returned by parser and can be traversed to collect children node information
+  # @attr [Class] parser_class class which was used to parse this ast
+  class Ast
+
+    attr_accessor :parser_class
+
+    # @return [Array<MetaCommit::Contracts::Ast>] children ast
+    def children
+
+    end
+
+    # @return [Integer, nil] line number where ast starts
+    def first_line
+
+    end
+
+    # @return [Integer, nil] line number where ast ends
+    def last_line
+
+    end
+  end
+end

data/lib/meta_commit_contracts/contextual_ast.rb

@@ -0,0 +1,10 @@
+module MetaCommit::Contracts
+  # Stores specific node from ast and all nodes bypassed on the way to target node
+  # Instances of this class are passed to {MetaCommit::Contracts::Diff#supports_change}
+  # @attr [MetaCommit::Contracts::Ast] target_node Target node from AST
+  # @attr [Array<MetaCommit::Contracts::Ast>] context_nodes Nodes bypassed on the way to target node
+  # @attr [Class] parser_class used to parse target node
+  class ContextualAst
+    attr_accessor :target_node, :context_nodes, :parser_class
+  end
+end

data/lib/meta_commit_contracts/diff.rb

@@ -0,0 +1,52 @@
+module MetaCommit::Contracts
+  # Diff contains data from changed element and is responsible for printing structured, user friendly message about change
+  class Diff
+
+    TYPE_ADDITION = :addition
+    TYPE_DELETION = :deletion
+    TYPE_REPLACE  = :replace
+
+    SUPPORTS_ALL_PARSERS_WILDCARD = :*
+
+    # @param [Class] parser
+    # @return [Boolean]
+    def supports_parser?(parser)
+
+    end
+
+    # @param [Symbol] type
+    # @param [String] old_file_name
+    # @param [String] new_file_name
+    # @param [] old_ast_path
+    # @param [] new_ast_path
+    # @return [Boolean]
+    def supports_change(type, old_file_name, new_file_name, old_ast_path, new_ast_path)
+
+    end
+
+    # @return [String]
+    def to_s
+
+    end
+
+    # @return [String]
+    def string_representation
+
+    end
+
+    # @return [Boolean]
+    def type_addition?
+
+    end
+
+    # @return [Boolean]
+    def type_deletion?
+
+    end
+
+    # @return [Boolean]
+    def type_replace?
+
+    end
+  end
+end

data/lib/meta_commit_contracts/errors.rb

@@ -0,0 +1,7 @@
+module MetaCommit::Contracts::Errors
+  class SourceCodeParsingError < StandardError
+    def initialize(msg='This content can not be parsed')
+      super(msg)
+    end
+  end
+end

data/lib/meta_commit_contracts/locator.rb

@@ -0,0 +1,13 @@
+module MetaCommit::Contracts
+  # Locator responsibility is to export parser classes and diff classes of extension
+  class Locator
+
+    # @return [Array<Class>] parser classes that package provides
+    def parsers
+    end
+
+    # @return [Array<Class>] diff classes that package provides
+    def diffs
+    end
+  end
+end

data/lib/meta_commit_contracts/parser.rb

@@ -0,0 +1,18 @@
+module MetaCommit::Contracts
+  # Parser responsibility is to build Ast node from code string
+  class Parser
+
+    # @return [Array<String>] supported extensions
+    def self.supported_file_extensions
+    end
+
+    # @return [Boolean]
+    def self.supports_syntax?(source_code)
+    end
+
+    # @param [String] source_code
+    # @return [MetaCommit::Contracts::Ast]
+    def parse(source_code)
+    end
+  end
+end

data/lib/meta_commit_contracts/version.rb

@@ -0,0 +1,5 @@
+module MetaCommit
+  module Contracts
+    VERSION = "0.1.0"
+  end
+end

data/meta_commit_contracts.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "meta_commit_contracts/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "meta_commit_contracts"
+  spec.version       = MetaCommit::Contracts::VERSION
+  spec.authors       = ["Stanislav Dobrovolskiy"]
+  spec.email         = ["uusername@protonmail.ch"]
+
+  spec.summary       = %q{Agreements for meta commit extension}
+  spec.homepage      = "https://github.com/meta_commit/contracts"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: meta_commit_contracts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stanislav Dobrovolskiy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- uusername@protonmail.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/meta_commit_contracts.rb
+- lib/meta_commit_contracts/ast.rb
+- lib/meta_commit_contracts/contextual_ast.rb
+- lib/meta_commit_contracts/diff.rb
+- lib/meta_commit_contracts/errors.rb
+- lib/meta_commit_contracts/locator.rb
+- lib/meta_commit_contracts/parser.rb
+- lib/meta_commit_contracts/version.rb
+- meta_commit_contracts.gemspec
+homepage: https://github.com/meta_commit/contracts
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Agreements for meta commit extension
+test_files: []