nummernkreis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a662d8dc677f9cf7f635ee3319ae1fb250f17945024bc714acce3e0a89c7b8d
+  data.tar.gz: 6abd42f788629f3d5b395dc49ee162dc1d45880de500502bffea0cd3a5c7a7fe
+SHA512:
+  metadata.gz: dd32be40f56ce8428833c7cb05ae5b548b3be0acdbdf9997420adbdaf4125c13addcebed3ac05a8f6158e8ec5ab248585e2dfba03f16c47be2f07b4133694508
+  data.tar.gz: eeb9242b94ed7fecc4d1f378440e58ec27a4aa1df8803303895d9cfec2a4aa32443e02cbaedec1fe7dd032978d658c3a2c66a85446f3d825bcd380378d1efd8c

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 1.17.2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    nummernkreis (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+    timecop (0.9.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  nummernkreis!
+  rake (~> 10.0)
+  timecop (~> 0.9.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Andreas Böhrnsen
+
+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,64 @@
+# Nummernkreis
+
+This gem implements a number range ("Nummernkreis" in German) which is very common for German documents like invoices where the invoice number is not just a number sequence but also includes date components.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nummernkreis'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nummernkreis
+
+## Usage
+
+When generating a new number range you need to specify its pattern.
+The following components are possible:
+
+```
+  yyyy: year with full 4 digits (e.g. 1980 or 2019)
+    yy: year with two digits (e.g. 19 for 2019)
+    mm: month starting with 1 (e.g. 02 for February)
+    dd: day of the month starting with 1 (e.g. 01 for first day)
+    - : dash separator
+    # : part of the sequence that will be incremented.
+```
+
+Examples (assuming current date is 2019-04-15):
+
+```ruby
+  Nummernkreis.new('####').to_s
+  # '0001'
+
+  Nummernkreis.new('yymmdd-##').to_s
+  # '190425-01'
+
+  Nummernkreis.new('yymmdd-##').next
+  # '190425-02'
+
+  Nummernkreis.new('yymmdd-##').parse('181231-04').next
+  # '181231-05'
+```
+
+## 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/deepflame/nummernkreis.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

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 "number_range"
+
+# 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/nummernkreis/version.rb

@@ -0,0 +1,3 @@
+class Nummernkreis
+  VERSION = "0.1.0"
+end

data/lib/nummernkreis.rb

@@ -0,0 +1,112 @@
+require "nummernkreis/version"
+require 'date'
+
+class Nummernkreis
+  class Error < StandardError; end
+
+  def initialize pattern
+    @pattern = pattern
+    @number = PatternParser.new(pattern).sample
+  end
+
+  def to_s
+    @number
+  end
+
+  def next
+    digit_count = @pattern.split('').count('#')
+    raise Error.new('only works if pattern has a digit part') if digit_count == 0
+
+    digits_start_at = @pattern.index('#')
+    digits_end_at = @pattern.rindex('#')
+
+    before_digits = digits_start_at < 1 ? '' : @number[0..digits_start_at-1]
+    digits = @number[digits_start_at..digits_end_at]
+    after_digits = @number[digits_end_at+1..@number.length]
+
+    new_digits = format("%0#{digit_count}d", digits.to_i + 1)
+
+    @number = "#{before_digits}#{new_digits}#{after_digits}"
+  end
+
+  def parse number
+    @number = number
+    self
+  end
+
+  private
+
+  class PatternParser
+
+    def initialize pattern
+      @state = []
+      @buffer = []
+      @number_parsed = false
+      parse pattern
+    end
+
+    def sample
+      @buffer.join
+    end
+
+    def parse pattern
+      pattern_copy = pattern.dup
+
+      while pattern_copy.length > 0
+        token = pattern_copy.slice!(0)
+        case token
+        when 'y'
+          process_current_state unless @state.include? :year
+          @state << :year
+        when 'm'
+          process_current_state unless @state.include? :month
+          @state << :month
+        when 'd'
+          process_current_state unless @state.include? :day
+          @state << :day
+        when '#'
+          process_current_state unless @state.include? :digit
+          @state << :digit
+        when '-'
+          process_current_state
+          @state << :dash
+        else
+          raise Error.new "token not recognized: #{token}"
+        end
+      end
+      process_current_state
+    end
+
+    def process_current_state
+      raise Error.new 'error in parser' if @state.uniq.length > 1
+
+      case @state.first
+      when :year
+        case @state.length
+        when 2
+          @buffer << Date.today.strftime('%y')
+        when 4
+          @buffer << Date.today.strftime('%Y')
+        else
+          raise Error.new 'year has 2 or 4 characters'
+        end
+      when :month
+        raise Error.new 'month has two characters' if @state.length != 2
+        @buffer << Date.today.strftime('%m')
+      when :day
+        raise Error.new 'day has two characters' if @state.length != 2
+        @buffer << Date.today.strftime('%d')
+      when :digit
+        raise Error.new('can only have one digit part') if @number_parsed
+        @buffer << format("%0#{@state.length}d", 1)
+        @number_parsed = true
+      when :dash
+        @buffer << '-'
+      end
+
+      @state.clear
+    end
+  end
+
+end
+

data/nummernkreis.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nummernkreis/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nummernkreis"
+  spec.version       = Nummernkreis::VERSION
+  spec.authors       = ["Andreas Böhrnsen"]
+  spec.email         = ["andreas@frontrunner.io"]
+
+  spec.summary       = %q{Number range (Nummernkreis) generator for documents like invoices.}
+  spec.description   = %q{Parses number range specification and returns the next valid (document) number.}
+  spec.homepage      = "https://github.com/frontrunnerio/nummernkreis"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+  #  spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "timecop", "~> 0.9.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: nummernkreis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andreas Böhrnsen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: Parses number range specification and returns the next valid (document)
+  number.
+email:
+- andreas@frontrunner.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nummernkreis.rb
+- lib/nummernkreis/version.rb
+- nummernkreis.gemspec
+homepage: https://github.com/frontrunnerio/nummernkreis
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/frontrunnerio/nummernkreis
+  source_code_uri: https://github.com/frontrunnerio/nummernkreis
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Number range (Nummernkreis) generator for documents like invoices.
+test_files: []