series_reminder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 500a7a51a22c09672e6ca014bba57f0c9448d3b1
+  data.tar.gz: 428c6589c42be636e38b3e5e7613e3b423b475ac
+SHA512:
+  metadata.gz: cc44bf0e2e2e86e0dd88b2d911bf71bc8eb72196d21d8f82e8d74075108545abb9add2dd79cbaaa88291bffa74c3e430e11b5338ff9de5af136341ab712ebd74
+  data.tar.gz: 1eeff14b92f1599b29d327a7981a05dc97435bb515f8759f0991faf6e12f64efb3b2f306240a71cb2795df07a23baac5bab5e9e470ad85c7d477eb49d019bb6b

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+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.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* 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
+
+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 nightterror@protonmail.ch. 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

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+group(:development) do
+  gem "rake"
+end
+
+# Specify your gem's dependencies in series_reminder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 relmay
+
+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,61 @@
+# Series Reminder
+
+## Installation
+
+Install it from rubygems:
+
+    $ gem install series_reminder
+
+Or, get the source and install it:
+```
+$ git clone https://github.com/relmay/series_reminder
+$ bundle install
+$ bundle exec rake install
+```
+## Usage
+Go to the directory where the files are located for viewing, and run the following command:
+
+    $ series -n
+
+This command should start playing the next series. If you don't use the mpv videoplayer, then you need to [specify your videoplayer in the config file](https://github.com/relmay/series_reminder/wiki/Configuring#videoplayer-execution-command).
+
+If the standard regular expression does not work with your files, then you can easily fix it by following the [instructions](https://github.com/relmay/series_reminder/wiki/Creating-regular-expressions-for-series_reminder#the-easiest-way-to-write-a-regular-expression).
+
+If you want to set custom regex to search for a file of the specified series in this directory:
+
+**Notice** that `%%SERIES%%` will be replaced with current series
+
+    $ series -r "[eE]%%SERIES%%"
+
+   For more information on creating regular expressions for series_reminder, visit the [wiki page]()
+
+Launching the selected series: 
+
+    $ series -s 5
+
+To show the number of the last viewed series:
+
+    $ series -l
+
+The rest of the functions can be found in the project [wiki](https://github.com/relmay/series_reminder/wiki).
+
+There is also the option of configuring the application. Information about this can be found on the [wiki page](https://github.com/relmay/series_reminder/wiki/config).
+
+
+## Development
+
+You can 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/relmay/series_reminder. 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).
+
+## Code of Conduct
+
+Everyone interacting in the SeriesReminder project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/relmay/series_reminder/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+task :install do
+  system "gem build series_reminder*.gemspec"
+  system "gem install series_reminder*.gem"
+
+  puts "Gem was installed"
+end

data/bin/series

@@ -0,0 +1,42 @@
+#!/bin/ruby
+
+require 'series_reminder'
+require 'optparse'
+
+series = SeriesReminder::Series.new
+
+OptionParser.new do |opts|
+  opts.banner = 'Series reminder ' + SeriesReminder::VERSION
+
+  opts.on('-o', '--open-series [SERIES]', Integer, 'Open the specified series.') do |s|
+    series.open_series(s)
+  end
+
+  opts.on('-c', '--config [FILE]', String, 'Read config from file.') do |s|
+    series.open_config_file(s)
+  end
+
+  opts.on('-s', '--set-series [SERIES]', String, 'Set last series.') do |s|
+    series.set_last_series(s)
+  end
+
+  opts.on('-r', '--set-regex [REGEX]', String, 'Set custom regex.') do |s|
+    series.set_regexp(s)
+  end
+
+  opts.on('-n', '--next-series', 'Open next series.') do
+    series.open_next
+  end
+
+  opts.on('-l', '--show-last', 'Show number of last viewed series.') do
+    puts "Number of last viewed series: #{series.get_last_series}"
+  end
+
+  opts.on('-i', '--init', 'Init program here.') do
+    series.init_storage()
+  end
+
+  opts.on('-v', '--version', 'Show version of program.') do
+    puts "Series Reminder " + SeriesReminder::VERSION
+  end
+end.parse!

data/lib/.series

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

data/lib/series_reminder/config.rb

@@ -0,0 +1,40 @@
+require 'yaml'
+require 'singleton'
+
+class Config
+  include Singleton
+
+  attr_reader :config
+
+  DEFAULT_CONFIG = {
+    "videoplayer_exec" => "mpv",
+    "default_regex" => "[Ee]%%SERIES%%",
+    "series_filename" => ".series",
+    "magic_word" => "%%SERIES%%"
+  }
+
+  def initialize()
+    load_config_file!(File.join(Dir.home, ".config/series_reminder/config.yml"))
+  end
+
+
+  def load_config_file!(config_location)
+    @config = YAML::load_file(config_location)
+
+    if (@config == false) 
+      @config = DEFAULT_CONFIG
+    else
+      complete_with_default_config!
+    end
+  rescue Errno::ENOENT
+    @config = DEFAULT_CONFIG
+  end
+
+  def complete_with_default_config!
+    DEFAULT_CONFIG.each do |a, b|
+      if (@config[a] == nil)
+        @config[a] = b
+      end
+    end
+  end
+end

data/lib/series_reminder/helpers.rb

@@ -0,0 +1,42 @@
+require_relative 'config'
+
+module Helpers
+  def get_series_with_zero(series)
+    if series < 10
+      return '0' + series.to_s
+    else
+      return series.to_s
+    end
+  end
+
+  def get_filename_by_series(series, regexp)
+    config = Config.instance
+    magic_word = config.config["magic_word"]
+
+    dir = Dir.entries('./')
+    valid_filename = nil
+
+    if regexp.nil?
+      default_regexp = config.config["default_regex"]
+      valid_regexp = default_regexp.gsub(magic_word, series)
+    else
+      valid_regexp = regexp.gsub(magic_word, series)
+    end
+
+    dir.each do |f| 
+      if /#{valid_regexp}/.match?(f)
+        valid_filename = f
+        break
+      end
+    end
+
+    valid_filename
+  rescue RegexpError
+    puts "Regex compiled incorrectly!"
+    exit 1
+  end
+
+  def filename(series, regexp)
+    get_filename_by_series(get_series_with_zero(series), regexp)
+  end
+end

data/lib/series_reminder/player.rb

@@ -0,0 +1,23 @@
+require_relative "config"
+
+module Player
+  @config = Config.instance
+
+  def self.open_videoplayer(filename)
+    system("#{@config.config["videoplayer_exec"]} \"#{filename}\"")
+  end
+
+  def self.open_next()
+    next_series = get_last + 1
+    set_last(next_series)
+    open_series(next_series)
+  end
+
+  def self.open(filename)
+    if filename.nil?
+      puts "File not found!"
+    else
+      open_videoplayer(filename)
+    end
+  end
+end

data/lib/series_reminder/series.rb

@@ -0,0 +1,49 @@
+require_relative 'storage'
+require_relative 'helpers'
+require_relative 'player'
+require_relative 'config'
+
+module SeriesReminder
+  class Series
+    include Helpers
+
+    def initialize
+      @storage = Storage.new
+    end
+
+    def open_series(series)
+      Player.open(filename(series))
+    end
+
+    def open_next
+      next_series = @storage.get_last + 1
+
+      Player.open(filename(next_series, @storage.get_regexp))
+
+      @storage.set_last(next_series)
+    rescue Interrupt
+      @storage.set_last(next_series)
+    end
+
+    def open_config_file(config_location)
+      config = Config.instance
+      config.load_config_file!(config_location)
+    end
+
+    def get_last_series
+      @storage.get_last
+    end
+
+    def set_regexp(regexp)
+      @storage.set_regexp(regexp)
+    end
+
+    def init_storage
+      @storage.init_file
+    end
+
+    def set_last_series(series)
+      @storage.set_last(series)
+    end
+  end
+end

data/lib/series_reminder/storage.rb

@@ -0,0 +1,76 @@
+require_relative 'config'
+
+class Storage
+  def initialize
+    @config = Config.instance
+
+    if file_exist?
+      @store = File.readlines(@config.config["series_filename"])
+    else
+      @store = []
+    end
+  end
+
+  def store_valid?
+    if file_exist?
+      return !(@store.length < 1 )
+    else
+      return false
+    end
+  end
+
+  def file_exist?
+    File.exist? @config.config["series_filename"]
+  end
+
+  def check_store
+    if !store_valid?
+      puts "Storage data is invalid!"
+      exit
+    end
+  end
+
+  def get_last
+    if (!file_exist?)
+      init_file
+    end
+
+    check_store
+    @store[0].to_i
+  end
+
+  def set_last(series)
+    @store[0] = series.to_s
+    update_store()
+  end
+
+  def update_store()
+    File.open(@config.config["series_filename"], 'w') do |file|
+      @store.each do |item|
+        file.puts item
+      end
+    end
+  end
+
+  def get_regexp()
+    if (@store[1].nil?)
+      return nil
+    else
+      return @store[1][0..-2]
+    end
+  end
+
+  def set_regexp(regexp)
+    @store[1] = regexp
+    update_store()
+  end
+
+  def init_file()
+    if store_valid?
+      puts "Already initialized!"
+    else
+      set_last 0 
+      puts "Successfully initialized."
+    end
+  end
+end

data/lib/series_reminder/version.rb

@@ -0,0 +1,3 @@
+module SeriesReminder
+  VERSION = "0.1.0"
+end

data/lib/series_reminder.rb

@@ -0,0 +1,5 @@
+require "series_reminder/version"
+
+module SeriesReminder
+  autoload :Series, 'series_reminder/series'
+end

data/series_reminder.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "series_reminder/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "series_reminder"
+  spec.version       = SeriesReminder::VERSION
+  spec.authors       = ["relmay"]
+  spec.email         = ["nightterror@protonmail.ch"]
+
+  spec.summary       = "A simple app that remembers the number of your last viewed series and can play next series."
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/relmay/series_reminder"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(bin)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = "series"
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: series_reminder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- relmay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: A simple app that remembers the number of your last viewed series and
+  can play next series.
+email:
+- nightterror@protonmail.ch
+executables:
+- series
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/series
+- lib/.series
+- lib/series_reminder.rb
+- lib/series_reminder/config.rb
+- lib/series_reminder/helpers.rb
+- lib/series_reminder/player.rb
+- lib/series_reminder/series.rb
+- lib/series_reminder/storage.rb
+- lib/series_reminder/version.rb
+- series_reminder.gemspec
+homepage: https://github.com/relmay/series_reminder
+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.6.13
+signing_key: 
+specification_version: 4
+summary: A simple app that remembers the number of your last viewed series and can
+  play next series.
+test_files: []