flagdoc 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 66bb3e6afa2f66c4744131898a5a8177c5cfde51b0223077766253ae8860ac86
+  data.tar.gz: 7d3a4864e0ded1194139fcc00d8e6b7a96cfc3628a8595b0447a926974a47dba
+SHA512:
+  metadata.gz: 8ae77886b49cb1841e5939ac979f51f32542cc7cdc228ba1789f5662174e037fc4e35706615985263bd3743fdccb6107c661b9d8619b5f081b0d510afc75ebde
+  data.tar.gz: 31ce8298222284510cdbfaa504efe0bbc0622e9d27e81d1b87a635eec14d004aea0c3b8981517c45a156bdb6ef58c87bb670b5fc148a0d44fac3e780c3b34166

data/.circleci/config.yml

@@ -0,0 +1,49 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.5.0-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            gem install bundler
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            bundle exec rspec
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.codeclimate.yml

@@ -0,0 +1,9 @@
+plugins:
+  reek:
+    enabled: true
+  rubocop:
+    enabled: true
+  flog:
+    enabled: true
+    config:
+      score_threshold: 20.0

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.1] - 2018-09-11
+### Fixed
+- Rubygem same version error
+
+## [0.1.0] - 2018-09-11
+### Added
+- Codeclimate to have automated code review
+- InchCi to display documentation badge
+- CircleCi for Continuous Integration
+- Simplecov for test coverage
+- RSpec for tests
+- Ruby version 2.5.1
+- Initialize project with the search for flags, a priority manager, and a beautiful STDOUT :)

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flagdoc.gemspec
+gemspec
+# Behaviour Driven Development for Ruby
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    flagdoc (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    json (2.1.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  flagdoc!
+  pry (~> 0.11)
+  rake (~> 10.0)
+  rspec
+  simplecov (~> 0.16)
+
+BUNDLED WITH
+   1.16.2

data/README.md

@@ -0,0 +1,51 @@
+<h1 align="center">Flagdoc</h1>
+
+<br/>
+
+<div align="center">
+  <a href='https://semaphoreci.com/nicolaslechenic/flagdoc'>
+    <img src='https://circleci.com/gh/nicolaslechenic/flagdoc/tree/master.svg?style=svg' alt='Build Status'>
+  </a>
+
+  <a href="https://codeclimate.com/github/nicolaslechenic/flagdoc/maintainability">
+    <img src="https://api.codeclimate.com/v1/badges/f7ce259947e2019f1e9f/maintainability" />
+  </a>
+
+  <a href="http://inch-ci.org/github/nicolaslechenic/flagdoc">
+    <img src="http://inch-ci.org/github/nicolaslechenic/flagdoc.svg?branch=master" />
+  </a>
+</div>
+
+---
+
+Flagdoc is an alternative to the rails notes inspired by the Yardoc syntax. Now, you can add customs flags with priority level
+
+**./example/file.rb**
+
+```ruby
+# @flag [OLD, HIGH] being removed, prefere bar method
+def foo
+  # Do something...
+end
+
+# @flag [NEW] replacing foo method
+def bar
+  # Do something...
+end
+
+# @flag [TODO, LOW] must be renamed to baz
+def bazz
+  # Do something...
+end
+```
+
+Will return something like that:
+
+![Terminal STDOUT](/files/example.png)
+
+## Levels:
+
+- LOW
+- NORMAL
+- HIGH
+

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 'flagdoc'
+
+# 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/flagdoc

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require_relative '../lib/flagdoc'
+require 'pry'
+
+store = Flagdoc::Store.new
+
+Dir['./**/*.rb'].each do |file|
+  strings = `grep -rn '# @flag' #{file}`
+
+  next if strings.empty?
+  strings.split("\n").each do |string|
+    parse = Flagdoc::Parser.new(string: string)
+
+    store.add(
+      path: parse.path,
+      line: parse.line,
+      type: parse.type,
+      priority: parse.priority,
+      description: parse.description
+    )
+  end
+end
+
+Flagdoc::Stream.new(store: store).()

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/flagdoc.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flagdoc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'flagdoc'
+  spec.version       = Flagdoc::VERSION
+  spec.authors       = ['Nicolas LE CHENIC']
+  spec.email         = ['pro.nicolaslechenic@gmail.com']
+
+  spec.summary       = 'Displays the flags written in your ruby ​​code'
+  spec.homepage      = 'https://github.com/nicolaslechenic/flagdoc'
+  spec.files         =
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+
+  spec.license       = 'MIT'
+  spec.executables   = ['flagdoc']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',    '~> 1.16'
+  spec.add_development_dependency 'pry',        '~> 0.11'
+  spec.add_development_dependency 'rake',       '~> 10.0'
+  spec.add_development_dependency 'rspec',      '~> 3.0'
+  spec.add_development_dependency 'simplecov',  '~> 0.16'
+end

data/lib/flagdoc/parser.rb

@@ -0,0 +1,55 @@
+module Flagdoc
+  # @since 0.1.0
+  class Parser
+    SPLIT_ORDER =
+      {
+        'path' => 0,
+        'line' => 1
+      }.freeze
+
+    def initialize(string:)
+      @string = string
+    end
+
+    # Generate methods:
+    # - path
+    # - line
+    #
+    # @since 0.1.0
+    #
+    # @return [String] with the information that depends
+    # on the name of the method
+    SPLIT_ORDER.each do |type, order|
+      define_method(type.to_s) { splitted[order] }
+    end
+
+    # @since 0.1.0
+    def type
+      type_and_priority.first.strip
+    end
+
+    # @since 0.1.0
+    def priority
+      return 'NORMAL' unless type_and_priority.count > 1
+      priority = type_and_priority.last.strip
+
+      Priority.available?(priority) ? priority : 'NORMAL'
+    end
+
+    # @since 0.1.0
+    def description
+      splitted[2].split(']').last.strip
+    end
+
+    private
+
+    def splitted
+      @splitted ||= @string.split(':')
+    end
+
+    def type_and_priority
+      @type_and_priority ||=
+        splitted[2][/\[(.*)\]/m, 1].strip.split(',')
+    end
+  end
+end

data/lib/flagdoc/priority.rb

@@ -0,0 +1,39 @@
+# Flagdoc is used to display custom flags with
+# priority manager in your terminal
+#
+# After installation you just need to enter flagdoc in
+# your terminal to display the available flags into the
+# current folder
+#
+# The syntax used is inspired by yardoc:
+#
+# @flag [MESSAGE, LOW] Hello world !
+module Flagdoc
+  # Define priorities levels
+  #
+  # @since 0.1.0
+  class Priority
+    LEVELS =
+      {
+        'LOW'     => '29',
+        'NORMAL'  => '166',
+        'HIGH'    => '196'
+      }.freeze
+
+    class << self
+      # @since 0.1.0
+      #
+      # @return [Boolean] true if the priority is available
+      def available?(priority)
+        LEVELS.key?(priority)
+      end
+
+      # @since 0.1.0
+      #
+      # @return [String] with bash color code
+      def color_code(priority)
+        '48;5;' + LEVELS[priority]
+      end
+    end
+  end
+end

data/lib/flagdoc/store.rb

@@ -0,0 +1,55 @@
+module Flagdoc
+  # Store parsed flags informations
+  #
+  # @since 0.1.0
+  class Store
+    attr_reader :files
+
+    # Store files data with flags infos
+    def initialize
+      @files = []
+    end
+
+    # Add flag to file path if already exist
+    # then add file path and flag to @files
+    #
+    # @since 0.1.0
+    def add(args)
+      return unless valid?(args)
+
+      flag = serialize_flag(args)
+      file = find_by_path(args[:path])
+
+      if file
+        file[:flags] << flag
+      else
+        add_file(args, flag)
+      end
+    end
+
+    private
+
+    # @return [Boolean] true if all args are ok
+    def valid?(args)
+      Priority.available?(args[:priority])
+    end
+
+    # @return [Hash] file with path
+    def find_by_path(path)
+      @files.find { |file| file[:path] == path }
+    end
+
+    def add_file(args, flag)
+      @files << { path: args[:path], flags: [flag] }
+    end
+
+    def serialize_flag(args)
+      {
+        type: args[:type],
+        priority: args[:priority],
+        line: args[:line],
+        description: args[:description]
+      }
+    end
+  end
+end

data/lib/flagdoc/stream.rb

@@ -0,0 +1,111 @@
+module Flagdoc
+  # Display parsed flags informations
+  #
+  # @since 0.1.0
+  class Stream
+    BOX_SIZE  = 54
+    LINE_SIZE = 12
+    TAB_SIZE  = 2
+    COLORS    =
+      {
+        'line'        => '90;48;5;192',
+        'description' => '90;48;5;194',
+        'file'        => '33;1'
+      }.freeze
+
+    # @since 1.0.1
+    def initialize(store:)
+      @store = store
+    end
+
+    # Launch the stream of stored informations
+    #
+    # @since 1.0.1
+    #
+    # @return [STDOUT] with formatted informations
+    def call
+      @store.files.each do |file|
+        file_path(file[:path])
+        flags(file[:flags])
+      end
+    end
+
+    private
+
+    # Generate methods:
+    # - file_color
+    # - line_color
+    # - description_color
+    #
+    # @return [String] with bash color code
+    COLORS.each do |type, code|
+      define_method("#{type}_color") { code }
+    end
+
+    def type_color(priority)
+      "1;97;#{Priority.color_code(priority)}"
+    end
+
+    # @return [STDOUT] colored file path
+    def file_path(path)
+      puts
+      puts "\e[#{file_color}m#{path}\e[0m"
+      puts
+    end
+
+    # @return [STDOUT] colored flags
+    def flags(flags)
+      flags.each do |flag|
+        head(flag[:type], "line #{flag[:line]}", flag[:priority])
+        blank
+        content(flag[:description])
+        blank
+        puts
+      end
+    end
+
+    def head(type, line, priority)
+      space_line    = space_line(LINE_SIZE - line.length)
+      space_type    = space_line((BOX_SIZE - LINE_SIZE - 2) - type.length)
+      line_content  = colorize(line_color, space_line + line)
+      type_content  = colorize(type_color(priority), type + space_type)
+
+      puts "#{tab}#{type_content}#{line_content}"
+    end
+
+    def blank
+      blank =
+        colorize(description_color, space_line(BOX_SIZE))
+
+      puts "#{tab}#{blank}"
+    end
+
+    def content(description)
+      space_description = space_line(BOX_SIZE - description.length)
+
+      description_content =
+        colorize(
+          description_color,
+          description.capitalize + space_description
+        )
+
+      puts "#{tab}#{description_content}"
+    end
+
+    def space_line(number)
+      ' ' * number
+    end
+
+    def tab(number = 1)
+      space_line(TAB_SIZE * number)
+    end
+
+    def colorize(color, content)
+      format(
+        "\e[%<color>sm %<content>s \e[0m",
+        color: color,
+        content: content
+      )
+    end
+  end
+end

data/lib/flagdoc/version.rb

@@ -0,0 +1,6 @@
+module Flagdoc
+  # Flagdoc version
+  #
+  # @since 0.1.0
+  VERSION = '0.1.1'.freeze
+end

data/lib/flagdoc.rb

@@ -0,0 +1,3 @@
+%w[parser priority store stream version].each do |file|
+  require_relative "flagdoc/#{file}"
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: flagdoc
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Nicolas LE CHENIC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: 
+email:
+- pro.nicolaslechenic@gmail.com
+executables:
+- flagdoc
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/flagdoc
+- bin/setup
+- files/example.png
+- flagdoc.gemspec
+- lib/flagdoc.rb
+- lib/flagdoc/parser.rb
+- lib/flagdoc/priority.rb
+- lib/flagdoc/store.rb
+- lib/flagdoc/stream.rb
+- lib/flagdoc/version.rb
+homepage: https://github.com/nicolaslechenic/flagdoc
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Displays the flags written in your ruby ​​code
+test_files: []