log_in_file 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de8f050430a0366393ca7534b358ec9e7b8a613ecd747c34715a8c42fda22f17
+  data.tar.gz: 10b00ec0d6f3e4015287e41fc17e075820574195d92ef26429194b1cf3eb1a1a
+SHA512:
+  metadata.gz: 38090265cc83ab05006df63d73ad40bdf852aca1e17b8950f2c317d266e93147692c016289ef38759ea59f95ed14bcae1d6caec4b69e1f831e3e2de51762c01d
+  data.tar.gz: 76cd3f8ac04e24e3e2d49adb10ce33f88bc52f93e60573ffa360e7ff61531096eff61c126aff83d7121830bc2d554879b918c918d60889667fde49bead08f362

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.3
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 1.0.0
+
+* First usable version.
+
+## 0.1.0
+
+* Création du gem (2023-10-01)

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in log_in_file.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    log_in_file (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.20.0)
+    minitest-color (0.0.2)
+      minitest (~> 5)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  log_in_file!
+  minitest (~> 5.0)
+  minitest-color
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,83 @@
+# LogInFile
+
+To write easily log messages in an output file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'log_in_file'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install log_in_file
+
+## Usage
+
+~~~ruby
+require 'log_in_file'
+
+logif("This message will be always written in a file.")
+
+Logif.severity_level = Logif::WARN|Logif::ERROR
+
+# This message will not be written
+logif(Logif::INFO, "Message written only for info")
+
+# This message will be written
+logif(Logif::WARN, "Be carefull!")
+
+~~~
+
+### Message with data (*template message*)
+
+~~~ruby
+
+msg = "This is a %{how} message."
+logif( msg, **{ data: { how: 'right' } } )
+
+# => write "This is a right message." in the log file.
+~~~
+
+To open the log file (to read it):
+
+~~~ruby
+Logif.open
+
+# or:
+
+Logif.start
+~~~
+
+To remove the log file:
+
+~~~ruby
+Logif.remove_log
+~~~
+
+
+### Severity levels
+
+~~~
+Logif::NOTICE
+Logif::INFO
+Logif::WARN
+Logif::ERROR
+~~~
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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_in_file.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "log_in_file"
+
+# 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/log_in_file/logif_module.rb

@@ -0,0 +1,36 @@
+module Logif
+  NOTICE  = 2
+  INFO    = 4
+  WARN    = 8
+  ERROR   = 16
+  ALL     = ERROR|WARN|INFO|NOTICE
+class << self
+
+
+  # @api
+  def severity_level=(value)
+    value.is_a?(Integer) || raise(ArgumentError.new("Logif.severity_level should be a Integer, not a #{value.class}."))
+    @severity_level = value
+  end
+
+  # @api
+  def remove_log
+    LogInFile.remove_log
+  end
+
+  # @api
+  def open
+    LogInFile.open_log
+  end
+  alias :start :open
+
+  def severity?(value)
+    (severity_level & value) > 0
+  end
+
+  def severity_level
+    @severity_level ||= Logif::ALL
+  end
+
+end #/ << self
+end

data/lib/log_in_file/main.rb

@@ -0,0 +1,94 @@
+#
+# Main method
+# 
+
+# @api
+# 
+# = main =
+# 
+# @param sevevity [Integer] [Optional]
+# @param message  [String] The message to log in the file
+# @param options  [Hash|Nil] Options
+#   :data       Data for template message (message with %{...})
+# 
+def logif(*args)
+  if args[0].is_a?(Integer)
+    severity, message, options = args
+    return unless Logif.severity?(severity)
+  else
+    message, options = args
+  end
+  options ||= {}    
+  LogInFile.write(message, **options) # return true if ok
+end
+
+module LogInFile
+class << self
+
+  def write(message, **options)
+    rf.puts(formated_message(message, **options))
+    return true
+  end
+
+  def formated_message(message, **options)
+    s = message.dup
+    s = s % options[:data] if options.key?(:data)
+    s = "--- #{Time.now.strftime(LOG_TIME_FORMAT)} #{s}"
+    return s
+  end
+
+  def open_log
+    close
+    `open "#{LogInFile.logfile_path}"`    
+  end
+
+  def rf
+    @rf ||= begin
+      File.open(logfile_path, File::APPEND|File::WRONLY|File::CREAT)
+    end
+  end
+
+  def close
+    @rf ||= nil
+    rf.close unless @rf.nil?
+    @rf = nil
+  end
+
+  def remove_log
+    close
+    File.delete(logfile_path) if File.exist?(logfile_path)
+  end
+
+  # Log file path
+  # 
+  def logfile_path
+    @logfile_path ||= File.join(logfile_folder, 'loginfile.log')
+  end
+
+  def logfile_folder
+    @logfile_folder ||= begin
+      if tmp_folder.nil?
+        File.expand_path('.')
+      else
+        tmp_folder
+      end
+    end
+  end
+
+  # Maybe a temp folder
+  def tmp_folder
+    @tmp_folder ||= find_temporary_folder
+  end
+
+  def find_temporary_folder
+    curdir = File.expand_path('.')
+    ['tmp','temp','temporary','.tmp'].each do |cname|
+      pth = File.join(curdir, cname)
+      return pth if File.exist?(pth)
+    end
+    return nil
+  end
+
+  LOG_TIME_FORMAT = '%Y %m %d %H:%M:%S'
+end #/ << self
+end #/ module LogInFile

data/lib/log_in_file/version.rb

@@ -0,0 +1,3 @@
+module LogInFile
+  VERSION = "1.0.0"
+end

data/lib/log_in_file.rb

@@ -0,0 +1,8 @@
+require "log_in_file/version"
+require "log_in_file/main"
+require "log_in_file/logif_module"
+
+module LogInFile
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/log_in_file.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/log_in_file/version'
+
+Gem::Specification.new do |s|
+  s.name          = "log_in_file"
+  s.version       = LogInFile::VERSION
+  s.authors       = ["PhilippePerret"]
+  s.email         = ["philippe.perret@yahoo.fr"]
+
+  s.summary       = %q{To easily log messages in a file}
+  s.description   = %q{Ruby gem to log messages in a output file easily.}
+  s.homepage      = "https://rubygems.org/gems/log_in_file"
+  s.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'minitest-color'
+
+  s.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  s.metadata["homepage_uri"] = s.homepage
+  s.metadata["source_code_uri"] = "https://github.com/PhilippePerret/gem-log_in_file"
+  s.metadata["changelog_uri"] = "https://github.com/PhilippePerret/gem-log_in_file/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|features)/}) }
+  end
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: log_in_file
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- PhilippePerret
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: minitest-color
+  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'
+description: Ruby gem to log messages in a output file easily.
+email:
+- philippe.perret@yahoo.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/log_in_file.rb
+- lib/log_in_file/logif_module.rb
+- lib/log_in_file/main.rb
+- lib/log_in_file/version.rb
+- log_in_file.gemspec
+homepage: https://rubygems.org/gems/log_in_file
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://rubygems.org/gems/log_in_file
+  source_code_uri: https://github.com/PhilippePerret/gem-log_in_file
+  changelog_uri: https://github.com/PhilippePerret/gem-log_in_file/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: To easily log messages in a file
+test_files: []