log_scroll 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 7eec51dc29d3dbaa158556e5fa9c1fabeb8195b6
4
+ data.tar.gz: b145d06603ace10df2f477cd4b79064a61b58947
5
+ SHA512:
6
+ metadata.gz: 17aa7b17cd4a6decf2a4e98839eaea9f31eb193878b5157d671df2935c6584853100272e89277e7a436e922b1463d49b89d61252ce28cb0562796bdede078a05
7
+ data.tar.gz: d1a07310fe05ec48d211ff58fb7103c15a587dddd7a8fe464d2cdd2b3a73eb8e31b8021ba481d683bd7d04b8eee9c9e3b14150a307bdfb098e8ff4cfbbeb4165
data/.gitignore ADDED
@@ -0,0 +1,10 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ test.log
data/.travis.yml ADDED
@@ -0,0 +1,3 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.1.3
@@ -0,0 +1,13 @@
1
+ # Contributor Code of Conduct
2
+
3
+ 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.
4
+
5
+ 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, age, or religion.
6
+
7
+ 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.
8
+
9
+ 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.
10
+
11
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12
+
13
+ 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 ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in log_scroll.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2015 David Begin
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,54 @@
1
+ # LogScroll
2
+
3
+ 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_scroll`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'log_scroll'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install log_scroll
22
+
23
+ ## Usage
24
+
25
+ Proposed API:
26
+
27
+ ```ruby
28
+ scroll = LogScroll.new(max_size: 10, file_name: "development.log")
29
+ scroll.log("first log entry")
30
+ scroll.log("second log entry")
31
+
32
+ scroll.entries
33
+ # => ["first log entry\n", "second log entry\n"]
34
+
35
+ puts "Oldest Entry: " + scroll.oldest_entry
36
+ # => "Oldest Entry: first log entry"
37
+
38
+ puts "Newest Entry: " + scroll.newest_entry
39
+ # => "Newest Entry: second log entry"
40
+ ```
41
+
42
+ ## Development
43
+
44
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
45
+
46
+ 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
47
+
48
+ ## Contributing
49
+
50
+ 1. Fork it ( https://github.com/[my-github-username]/log_scroll/fork )
51
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
52
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
53
+ 4. Push to the branch (`git push origin my-new-feature`)
54
+ 5. Create a new Pull Request
data/Rakefile ADDED
@@ -0,0 +1,2 @@
1
+ require "bundler/gem_tasks"
2
+
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "log_scroll"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,6 @@
1
+ require_relative "../lib/log_scroll"
2
+
3
+ p scroll = LogScroll.new(file_name: "test.log", max_size: 4)
4
+ scroll.log("hello1")
5
+ puts "Oldest Entry: " + scroll.oldest_entry.to_s
6
+ puts "Newest Entry: " + scroll.newest_entry.to_s
data/lib/log_scroll.rb ADDED
@@ -0,0 +1,65 @@
1
+ require_relative "log_scroll/version"
2
+ require "fileutils"
3
+
4
+ module LogScroll
5
+ def self.new(file_name:, max_size: 100)
6
+ Scroll.new(file_name: file_name, max_size: max_size)
7
+ end
8
+
9
+ class Scroll
10
+
11
+ def initialize(file_name:, max_size:)
12
+ @file_name = file_name
13
+ @max_size = max_size
14
+ find_create_history_file!
15
+ entries
16
+ end
17
+
18
+ def log(log_entry)
19
+ append_log_entry(log_entry)
20
+ end
21
+
22
+ def entries
23
+ @entries = Array(log_file.each_line.to_a)
24
+ end
25
+
26
+ def newest_entry
27
+ @entries.last
28
+ end
29
+
30
+ def oldest_entry
31
+ @entries.first
32
+ end
33
+
34
+ def entry_count
35
+ entries.count
36
+ end
37
+
38
+ private
39
+
40
+ attr_reader :file_name, :max_size
41
+
42
+ def append_log_entry(log_entry)
43
+ @entries.shift if entry_count == max_size
44
+ if entry_count >= max_size
45
+ ((entry_count + 1) - max_size).times { @entries.shift }
46
+ end
47
+
48
+ @entries << "#{log_entry}\n"
49
+
50
+ File.open(file_name, "w+") do |file|
51
+ file.write(@entries.join(""))
52
+ end
53
+ end
54
+
55
+ def log_file
56
+ File.open(file_name, "r+")
57
+ end
58
+
59
+ def find_create_history_file!
60
+ unless File.exists? file_name
61
+ FileUtils.touch file_name
62
+ end
63
+ end
64
+ end
65
+ end
@@ -0,0 +1,3 @@
1
+ module LogScroll
2
+ VERSION = "0.1.1"
3
+ end
@@ -0,0 +1,24 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'log_scroll/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "log_scroll"
8
+ spec.version = LogScroll::VERSION
9
+ spec.authors = ["David Begin"]
10
+ spec.email = ["davidmichaelbe@gmail.com"]
11
+
12
+ spec.summary = %q{A simple gem for managing rolling Logs}
13
+ spec.description = %q{Rolling Logs in Ruby}
14
+ spec.homepage = "https://github.com/presidentJFK/log-scroll"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_development_dependency "bundler", "~> 1.8"
23
+ spec.add_development_dependency "rake", "~> 10.0"
24
+ end
metadata ADDED
@@ -0,0 +1,86 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: log_scroll
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - David Begin
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2015-08-17 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.8'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.8'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ description: Rolling Logs in Ruby
42
+ email:
43
+ - davidmichaelbe@gmail.com
44
+ executables: []
45
+ extensions: []
46
+ extra_rdoc_files: []
47
+ files:
48
+ - ".gitignore"
49
+ - ".travis.yml"
50
+ - CODE_OF_CONDUCT.md
51
+ - Gemfile
52
+ - LICENSE.txt
53
+ - README.md
54
+ - Rakefile
55
+ - bin/console
56
+ - bin/setup
57
+ - examples/sample.rb
58
+ - lib/log_scroll.rb
59
+ - lib/log_scroll/version.rb
60
+ - log_scroll.gemspec
61
+ homepage: https://github.com/presidentJFK/log-scroll
62
+ licenses:
63
+ - MIT
64
+ metadata: {}
65
+ post_install_message:
66
+ rdoc_options: []
67
+ require_paths:
68
+ - lib
69
+ required_ruby_version: !ruby/object:Gem::Requirement
70
+ requirements:
71
+ - - ">="
72
+ - !ruby/object:Gem::Version
73
+ version: '0'
74
+ required_rubygems_version: !ruby/object:Gem::Requirement
75
+ requirements:
76
+ - - ">="
77
+ - !ruby/object:Gem::Version
78
+ version: '0'
79
+ requirements: []
80
+ rubyforge_project:
81
+ rubygems_version: 2.2.2
82
+ signing_key:
83
+ specification_version: 4
84
+ summary: A simple gem for managing rolling Logs
85
+ test_files: []
86
+ has_rdoc: