martha 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7fcb18bf887e51b4382081576b73e1f5e79538d1
+  data.tar.gz: 953f937418bf85aee22645dfb71abf003dfcef79
+SHA512:
+  metadata.gz: 260180237f6f8fcdba7d427877cf4b3ebd4fe8352ebf9066b5e04f64a6491b3e073adebd9d50140bdacb3aa47d063b1f81070eb89c111fef1f053685d1e16a28
+  data.tar.gz: 527228ce3a8a3d8efdaba7cbfd61455334d361644f9ec9e79a6f8b04c3ee518214dad5e9cc687a47f9841298fc94adeb712c97d607ec0109334c45c0208bca84

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Codeclimate
+gem 'codeclimate-test-reporter', group: :test, require: nil
+
+# gem "codeclimate-test-reporter", group: :test, require: nil
+gem 'nokogiri'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,98 @@
+PATH
+  remote: .
+  specs:
+    martha (0.0.0)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    codeclimate-engine-rb (0.3.1)
+      virtus (~> 1.0)
+    codeclimate-test-reporter (0.6.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.1)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    equalizer (0.0.11)
+    ice_nine (0.11.2)
+    json (2.0.2)
+    method_source (0.8.2)
+    mini_portile2 (2.1.0)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    pkg-config (1.1.7)
+    powerpack (0.1.1)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (2.1.0)
+    rake (10.5.0)
+    reek (4.4.0)
+      codeclimate-engine-rb (~> 0.3.1)
+      parser (~> 2.3.1, >= 2.3.1.2)
+      rainbow (~> 2.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.42.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    unicode-display_width (1.1.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  codeclimate-test-reporter
+  martha!
+  nokogiri
+  pry
+  rake (~> 10.0)
+  reek
+  rspec
+  rubocop
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Victor Elizalde
+
+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,47 @@
+# Martha
+Gem that documents code/software for a better organisation and understanding of it by developers.
+
+## Table of contents
+- [Installation](#installation)
+- [Usage](#usage)
+- [What it actually do?](#what-it-actually-do)
+- [Contributing](#contributing)
+- [Credits](#author-and-contributor-list)
+
+## Installation
+Pre-install:
+- Windows Users: Install ruby environment, we recommend [RubyInstaller](http://rubyinstaller.org/downloads/) and after install [Development Kit](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit) and now you can use Ruby's gems.
+
+To install the gem you can just run the following command:
+
+```console
+% gem install martha
+```
+## What it actually do?
+Command:
+```console
+% martha docu <NAME_FILE>
+```
+And your code is documented. Easy
+
+Programming Lenguages Supported:
+- Ruby
+- C++
+
+## Usage
+
+You only need to use the martha command:
+
+```console
+% martha docu <NAME_FILE>
+```
+
+## Contributing
+Everyone is freely to collaborate and submit pull request if needed.
+You can add more support for new programming lenguages.
+
+##Author and Contributor List
+-------------------
+- Victor Elizalde
+- Oscar Michel Herrera
+- Mauricio Cortés

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/martha

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'martha'
+
+Martha::Builder.start( ARGV )

data/development-entrypoint.sh

@@ -0,0 +1,5 @@
+#! /bin/bash
+
+bundle
+
+exec "$@"

data/docker-compose.yml

@@ -0,0 +1,16 @@
+version: "2"
+
+volumes:
+  gems:
+    driver: local
+services:
+  martha:
+    image: ruby:2.3.0
+    entrypoint: /usr/src/martha/development-entrypoint.sh
+    command: bash
+    volumes:
+      - .:/usr/src/martha
+      - gems:/usr/local/bundle
+    working_dir: /usr/src/martha
+    tty: true
+    stdin_open: true

data/lib/martha/builder.rb

@@ -0,0 +1,170 @@
+require 'thor'
+require 'pry'
+require 'nokogiri'
+
+module Martha
+  class Builder < Thor
+    include Martha
+    include Thor::Actions
+
+    def initialize(args = [], local_options = {}, config = {})
+      super
+      @author = "Victor Elizalde"
+      @file_info = []
+      @description = ""
+      @output_description = ""
+      @input_description = ""
+      @method_info = []
+      @file_name = ""
+    end
+
+    desc 'reveal FILE_NAME', 'It documents code'
+    def reveal(file_name)
+      @file_name = file_name
+      if File.file?(@file_name)
+        greetings
+        if file_name.split('.')[1] == "cpp"
+          puts "I found #{method_quantity_cpp} undocumented method(s)/function(s)\n\n"
+          document_methods_cpp
+        else
+          puts "I found #{method_quantity_rb} undocumented method(s)/function(s)\n\n"
+          document_methods_rb
+        end
+      else
+        error
+      end
+    end
+
+    private
+
+    def document_methods_cpp
+      File.open(@file_name, 'w') { |file|
+        @file_info.each do |line|
+          if cpp_function?(line)
+            fill_method_info line
+            @method_info.each do |line|
+              file.write("#{line}")
+            end
+            file.write("#{line.chop} //function\n")
+          else
+            file.write("#{line}")
+          end
+        end
+      }
+    end
+
+    def document_methods_rb
+      File.open(@file_name, 'w') { |file|
+        @file_info.each do |line|
+          if rb_function?(line)
+            fill_method_info line
+            @method_info.each do |line|
+              file.write("#{line}")
+            end
+            file.write("#{line.chop} #method\n")
+          else
+            file.write("#{line}")
+          end
+        end
+      }
+    end
+
+    def fill_method_info(line)
+      puts "For the following method/function:\n\n"
+      puts "         #{line}"
+      print "\nInput Description (What does it receives?)\nYour Answer: "
+      @input_description = STDIN.gets.chomp
+      print "\nOutput Description (What does it returns?)\nYour Answer: "
+      @output_description = STDIN.gets.chomp
+      print "\nDescription (What does the method does?)\nYour Answer: "
+      @description = STDIN.gets.chomp
+      puts "\n"
+      if @file_name.split('.')[1] == "cpp"
+        write_method_info_cpp line
+      else
+        write_method_info_rb line
+      end
+    end
+
+    def write_method_info_rb(line)
+      @method_info = []
+      if line.include?('(')
+        title = line.split('(')[0].split(' ')[1]
+        input = line.split('(')[1].chop
+        input[input.size-1] = ''
+      else
+        title = line.split(' ')[1]
+        input = "()"
+      end
+      output = line.split('(')[0].split(' ')[0]
+      @method_info << "#Title: #{title}\n"
+      @method_info << "#Input: #{input}\n"
+      @method_info << "#Input Description: #{@input_description}\n"
+      @method_info << "#Output Description: #{@output_description}\n"
+      @method_info << "#Description: #{@description}\n"
+      @method_info << "#Author: #{@author}\n"
+      @method_info
+    end
+
+    def write_method_info_cpp(line)
+      @method_info = []
+      @method_info << "/*\n"
+      title = line.split('(')[0].split(' ')[1]
+      input = line.split('(')[1].chop
+      input[input.size-1] = ''
+      output = line.split('(')[0].split(' ')[0]
+      @method_info << "Title: #{title}\n"
+      @method_info << "Input: #{input}\n"
+      @method_info << "Input Description: #{@input_description}\n"
+      @method_info << "Output: #{output}\n"
+      @method_info << "Output Description: #{@output_description}\n"
+      @method_info << "Description: #{@description}\n"
+      @method_info << "Author: #{@author}\n"
+      @method_info << "*/\n"
+      @method_info
+    end
+
+    def greetings
+      puts "Hello I'm Martha!\n\n"
+      puts "With whom I have the pleasure?\n\n"
+      print "Your Name: "
+      @author = STDIN.gets.chomp
+      puts "\n"
+    end
+
+    def method_quantity_cpp
+      method_quantity = 0
+      file = File.open(@file_name)
+      file.each_line do |line|
+        method_quantity += 1 if cpp_function?(line)
+        @file_info << line
+      end
+      method_quantity
+    end
+
+    def method_quantity_rb
+      method_quantity = 0
+      file = File.open(@file_name)
+      file.each_line do |line|
+        method_quantity += 1 if rb_function?(line)
+        @file_info << line
+      end
+      method_quantity
+    end
+
+    def cpp_function?(line)
+      if line.include?('(') && !line.include?('//function')
+        header = line.split('(')[0]
+        header.split(' ').size == 2 && header.split(' ').first != "else" && header.split(' ').last != "main"
+      end
+    end
+
+    def rb_function?(line)
+      line.split(' ')[0] == "def" && !line.include?('#method')
+    end
+
+    def error
+      puts "I'm sorry, but the file doesn't exist"
+    end
+  end
+end

data/lib/martha/version.rb

@@ -0,0 +1,3 @@
+module Martha
+  VERSION = '0.0.0'.freeze
+end

data/lib/martha.rb

@@ -0,0 +1 @@
+require 'martha/builder'

data/martha.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'martha/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'martha'
+  spec.version       = Martha::VERSION
+  spec.authors       = ['Victor Elizalde', 'Mauricio Cortes', 'Oscar Michel']
+  spec.email         = ['vic-bull@hotmail.com']
+  spec.summary       = 'A ruby gem to dockerize applications.'
+  spec.description   = 'A ruby gem to dockerize applications.'
+  spec.homepage      = 'https://github.com/VictorElizalde/Martha'
+  spec.license       = 'MIT'
+  spec.executables << "martha"
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.bindir        = 'bin'
+  spec.executables   = ['martha']
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'reek'
+
+  spec.add_dependency 'thor'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: martha
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Victor Elizalde
+- Mauricio Cortes
+- Oscar Michel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby gem to dockerize applications.
+email:
+- vic-bull@hotmail.com
+executables:
+- martha
+extensions: []
+extra_rdoc_files: []
+files:
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/martha
+- development-entrypoint.sh
+- docker-compose.yml
+- lib/martha.rb
+- lib/martha/builder.rb
+- lib/martha/version.rb
+- martha.gemspec
+homepage: https://github.com/VictorElizalde/Martha
+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: A ruby gem to dockerize applications.
+test_files: []