README.md

Mulang Gem

Ruby Gem Wrapper for the mulang code anayzer.

Installation

Add this line to your application's Gemfile:

gem 'mulang'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mulang

Usage

Expectations checking

code = Mulang::Code.native('JavaScript',  'function plusOne(x) { return x + 1 }')

code.expect 'plusOne', 'Not:DeclaresVariable'
# => true

code.custom_expect %q{
  expectation "declares the `plusOne` function":
    declares function `plusOne` that (returns with math);
  expectation "not uses variables for literals":
    !declares variable with literal}
# => {"declares the `plusOne` function"=>true, "not uses variables for literals"=>true}

AST Generation

code = Mulang::Code.new(Mulang::Language::Native.new('JavaScript'),  'let x = 1')

# shortcut
code = Mulang::Code.native('JavaScript',  'let x = 1')

# generate ast
code.ast
# => {"tag"=>"Variable", "contents"=>["x", {"tag"=>"MuNumber", "contents"=>1}]}

Build and run analysis

code = Mulang::Code.native('JavaScript',  'let x = 1')

code.analysis expectations: [], smellsSet: { tag: 'NoSmells' }
# => {:sample=>{:tag=>"CodeSample", :language=>"JavaScript", :content=>"let x = 1"}, :spec=>{:expectations=>[], :smellsSet=>{:tag=>"NoSmells"}}}

code.analyse expectations: [], smellsSet: { tag: 'NoSmells' }
# => {"tag"=>"AnalysisCompleted", "outputAst"=>nil, "signatures"=>[], "smells"=>[], "expectationResults"=>[]}

Build and run analysis

code = Mulang::Code.native('JavaScript',  'let x = 1')

code.analysis expectations: [], smellsSet: { tag: 'NoSmells' }
# => {:sample=>{:tag=>"CodeSample", :language=>"JavaScript", :content=>"let x = 1"}, :spec=>{:expectations=>[], :smellsSet=>{:tag=>"NoSmells"}}}

code.analyse expectations: [], smellsSet: { tag: 'NoSmells' }
# => {"tag"=>"AnalysisCompleted", "outputAst"=>nil, "signatures"=>[], "smells"=>[], "expectationResults"=>[]}

Internationalization

I18n.locale = :en

Mulang::Expectation.parse(binding:  '*', inspection:'Declares:foo').translate
# => solution must declare <strong>foo</strong>

Raw mulang execution

require 'mulang'

Mulang.analyse sample: {
                  tag: 'CodeSample',
                  language: 'JavaScript',
                  content: 'let x = 1'
               },
               spec: {
                expectations: [],
                smellsSet: {
                  tag: 'NoSmells'
                }
              }
# => {"tag"=>"AnalysisCompleted", "outputAst"=>nil, "signatures"=>[], "smells"=>[], "expectationResults"=>[]}

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Installing Locally

To install this gem onto your local machine, run bundle exec rake install.

Locally updating Mulang version

Edit version.rb with a new Mulang version, and then run bin/setup again.

Releasing a new version

This gem is automatically released with each mulang version.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mumumuki/mulang. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Mulang project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.