log_marker 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c4562ff9d4c28819b7c39a98ece4983e3c885ab
-  data.tar.gz: a37b6f7e754cd0905bc1ddfcd4ce0ce9c797c759
+  metadata.gz: 901259ddef5ec66b1a33351ddb322349b189b272
+  data.tar.gz: e0ccdcc2fd3218989be8bbeb12640abfac8458bc
 SHA512:
-  metadata.gz: f9ff261851c35535722bcaa76492f25af61d830585ec67a8baa120c45a58383be25ac0ff9dd805bcd783cfb183918fe81308ab4d27ec45e9e5013a37be9e085e
-  data.tar.gz: 494059321c3af625d4f68a2884bde20740c41e3f363f40cd4038ea24d06322087b09af8fbc86453b7f63990bee102efe5718cd2d767e29e847fac02f9fa2a229
+  metadata.gz: e292ef7a6df46d67dbe983f84b54be54810e4ec56f1988d1a613b67e9b8f02260b540a592330b1fb819b91f0b3048ec0c406538b04e7ae603834d508121de131
+  data.tar.gz: 195caf3cabaffab88fabe8c0ea29adb5905ff8245ef54547ed8f38941c652b6e44608f22846ef5eb95f017cbb2d05c4e8cc05a6d5ef75fa68cb748a23b02c98e

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -1,4 +1,5 @@
+sudo: false
 language: ruby
 rvm:
-  - 2.0.0
-before_install: gem install bundler -v 1.10.5
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -1,13 +1,74 @@
-# Contributor Code of Conduct
+# Contributor Covenant 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.
+## Our Pledge
 
-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.
+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.
 
-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.
+## Our Standards
 
-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.
+Examples of behavior that contributes to creating a positive environment
+include:
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+* 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
 
-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/)
+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 jun.okada0203@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

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    log_marker (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    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.2)
+      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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  log_marker!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 TODO: Write your name
+Copyright (c) 2019 Jun0kada
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,8 +1,6 @@
 # LogMarker
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/log_marker`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+debug logging with marker
 
 ## Installation
 
@@ -22,20 +20,130 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+log_marker methods
+`ml`, `p!`, `pp!`, `puts!`
+
+```ruby
+ml 'Hello my debug log'
+# => ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+#
+#
+#
+#
+#
+# "Hello my debug log"
+#
+#
+#
+#
+#
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+
+p! 'Hello my debug log'
+# => ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+#
+#
+#
+#
+#
+# "Hello my debug log"
+#
+#
+#
+#
+#
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+
+puts! 'Hello my debug log'
+# => ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+#
+#
+#
+#
+#
+# Hello my debug log
+#
+#
+#
+#
+#
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+
+pp! ['Hello my debug log'] * 5
+# => ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+#
+#
+#
+#
+#
+# ["Hello my debug log",
+#  "Hello my debug log",
+#  "Hello my debug log",
+#  "Hello my debug log",
+#  "Hello my debug log"]
+#
+#
+#
+#
+#
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+# ======================================================================================================================================================
+```
+
+## Config
+
+```ruby
+LogMarker.config do |config|
+  config.ml_alias = :p!
+  config.marker   = -> { (['=' * 150] * 5).join("\n") }
+end
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/log_marker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/log_marker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
 
+Everyone interacting in the LogMarker project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/log_marker/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -11,4 +11,4 @@ require "log_marker"
 # Pry.start
 
 require "irb"
-IRB.start
+IRB.start(__FILE__)

data/bin/setup

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

data/lib/log_marker/config.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module LogMarker
+  class << self
+    attr_accessor :ml_alias, :marker
+
+    def config
+      yield self
+    end
+  end
+
+  @ml_alias = :p!
+  @marker   = -> { (['=' * 150] * 5).join("\n") }
+end

data/lib/log_marker/version.rb

@@ -1,3 +1,3 @@
 module LogMarker
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

data/lib/log_marker.rb

@@ -1,2 +1,40 @@
-require "log_marker/version"
-require "log_marker/extention/active_support/object"
+# frozen_string_literal: true
+
+require 'pp'
+require 'log_marker/version'
+require 'log_marker/config'
+
+module LogMarker
+  MARK_METHODS = %w(p pp puts)
+
+  MARK_METHODS.each do |name|
+    define_method("#{name}!") do |*args|
+      logging_with_marker do
+        send(name, *args)
+      end
+    end
+  end
+
+  def logging_with_marker(&block)
+    puts marker
+
+    result = block.call
+
+    puts marker.reverse
+
+    result
+  end
+
+  def marker
+    [
+      LogMarker.marker.respond_to?(:call) ? LogMarker.marker.call : LogMarker.marker.to_s,
+      "\n" * 5
+    ]
+  end
+
+  def ml(*args)
+    send(LogMarker.ml_alias, *args)
+  end
+end
+
+Object.include LogMarker

data/log_marker.gemspec

@@ -1,28 +1,26 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'log_marker/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "log_marker"
+  spec.name          = 'log_marker'
   spec.version       = LogMarker::VERSION
-  spec.authors       = ["JunOkada"]
-  spec.email         = ["jun.okada0203@gmail.com"]
+  spec.authors       = ['Jun0kada']
+  spec.email         = ['jun.0kada.dev@gmail.com']
 
-  spec.summary       = %q{Add marker to debug logs}
-  spec.description   = %q{Add marker to debug logs}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.summary       = 'Add marker to debug logs'
+  spec.description   = 'Add marker to debug logs'
+  spec.homepage      = 'https://github.com/Jun0kada/log_marker'
+  spec.license       = 'MIT'
 
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
-  # delete this section to allow pushing this gem to any host.
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  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 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,79 +1,80 @@
 --- !ruby/object:Gem::Specification
 name: log_marker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
-- JunOkada
+- Jun0kada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-05 00:00:00.000000000 Z
+date: 2019-03-03 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'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.16'
 - !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'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 description: Add marker to debug logs
 email:
-- jun.okada0203@gmail.com
+- jun.0kada.dev@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/log_marker.rb
-- lib/log_marker/extention/active_support/object.rb
+- lib/log_marker/config.rb
 - lib/log_marker/version.rb
 - log_marker.gemspec
-homepage: ''
+homepage: https://github.com/Jun0kada/log_marker
 licenses:
 - MIT
 metadata: {}
@@ -83,17 +84,17 @@ 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.4.6
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Add marker to debug logs

data/lib/log_marker/extention/active_support/object.rb

@@ -1,7 +0,0 @@
-class Object
-  def lm(*arg)
-    puts "\e[31m" + '■'*10 + '<debug>' + '■'*10 + "\e[0m"
-    p *arg
-    puts "\e[31m" + '■'*10 + '</debug>' + '■'*10 + "\e[0m"
-  end
-end