defoker 0.0.1

data/defoker.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'defoker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'defoker'
+  spec.version       = Defoker::VERSION
+  spec.authors       = ['tbpgr']
+  spec.email         = ['tbpgr@tbpgr.jp']
+  spec.summary       = %q(Create variaous kind of date-base format named folders.)
+  spec.description   = %q(Create variaous kind of date-base format named folders.)
+  spec.homepage      = 'https://github.com/tbpgr/defoker'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'timecop'
+end

data/lib/date_base_name.rb

@@ -0,0 +1,165 @@
+# encoding: utf-8
+require 'date'
+
+module Defoker
+  # DateBaseName provides methods that various kind of date-base formated name.
+  # date base, month base, year base, and etc...
+  class DateBaseName
+    # Get date-base formated name.
+    # if additional is empty, return date YYYYMMDD.
+    # if additional is not empty, return date YYYYMMDD_additional.
+    #
+    # @example only date
+    #   DateBaseName.new.to_yyyymmdd(Date.new(2014,9,9)) #=> "20140909"
+    # @example date with additional text
+    #   DateBaseName.new.to_yyyymmdd(Date.new(2014,9,9), additional: 'hoge') #=> "20140909_hoge"
+    #
+    # @param [Date,DateTime] date target date
+    # @param [String] additional additional text.
+    #     If you want to get only date, you can omit this option.
+    # @return [String] date-based formated name
+    #
+    def to_yyyymmdd(date, additional: '')
+      DateBaseNameValidators.validate_date(date)
+      v = date.strftime('%Y%m%d')
+      return v if additional.empty?
+      "#{v}_#{additional}"
+    end
+
+    # Get date-base formated name list.
+    # if additional is empty, return date YYYYMMDD.
+    # if additional is not empty, return date YYYYMMDD_additional.
+    #
+    # @example only date
+    #   DateBaseName.new.to_yyyymmdd_list(Date.new(2014,9,9), Date.new(2014,9,12))
+    #   => ["20140909","20140910","20140911","20140912"]
+    # @example date with additional text
+    #   DateBaseName.new.to_yyyymmdd_list(Date.new(2014,9,9), count: Date.new(2014,9,12), additional: 'hoge')
+    #   => ["20140909_hoge", "20140910_hoge", "20140911_hoge", "20140912_hoge"]
+    # @example range
+    #   DateBaseName.new.to_yyyymmdd_list(Date.new(2014,9,9)..Date.new(2014,9,12), additional: 'hoge')
+    #   => ["20140909_hoge", "20140910_hoge", "20140911_hoge", "20140912_hoge"]
+    #
+    # @param [Date,DateTime,Range] day date or from-count range
+    # @param [Date] count count date.
+    # @param [String] additional additional text.
+    #     If you want count get only date, you can omit this option.
+    # @return [Array(String)] date-based formated names
+    def to_yyyymmdd_list(day, count: nil, additional: '')
+      DateBaseNameValidators.validate_date(day)
+      count.times.with_object([]) do |i, memo|
+        memo << to_yyyymmdd(day + i, additional: additional)
+      end
+    end
+
+    # Get month-base formated name.
+    # if additional is empty, return month YYYYMM.
+    # if additional is not empty, return month YYYYMM_additional.
+    #
+    # @example only month
+    #   DateBaseName.new.to_yyyymm(Date.new(2014,9)) #=> "201409"
+    # @example month with additional text
+    #   DateBaseName.new.to_yyyymm(Date.new(2014,9), additional: 'hoge') #=> "201409_hoge"
+    #
+    # @param [Date,DateTime] month target month
+    # @param [String] additional additional text.
+    #     If you want to get only month, you can omit this option.
+    # @return [String] month-based formated name
+    #
+    def to_yyyymm(month, additional: '')
+      DateBaseNameValidators.validate_date(month)
+      v = month.strftime('%Y%m')
+      return v if additional.empty?
+      "#{v}_#{additional}"
+    end
+
+    # Get month-base formated name list.
+    # if additional is empty, return month YYYYMM.
+    # if additional is not empty, return month YYYYMM_additional.
+    #
+    # @example only month
+    #   DateBaseName.new.to_yyyymm_list(Date.new(2014,10), count: 4))
+    #   => ["201410","201411","20141","201501"]
+    # @example only month (omit count. default = 3)
+    #   DateBaseName.new.to_yyyymm_list(Date.new(2014,10)))
+    #   => ["201410","201411","20141"]
+    # @example month with additional text
+    #   DateBaseName.new.to_yyyymm_list(Date.new(2014,9,9), count: 4, additional: 'hoge')
+    #   => ["201410_hoge","201411_hoge","20141_hoge","201501_hoge"]
+    #
+    # @param [Date,DateTime] month month
+    # @param [Fixnum] count month count. default = 3.
+    # @param [String] additional additional text.
+    #     If you want to get only month, you can omit this option.
+    # @return [Array(String)] month-based formated names
+    def to_yyyymm_list(month, count: 3, additional: '')
+      DateBaseNameValidators.validate_date(month)
+      count.times.with_object([]) do |i, memo|
+        memo << to_yyyymm(month >> i, additional: additional)
+      end
+    end
+
+    # Get year-base formated name.
+    # if additional is empty, return year YYYY.
+    # if additional is not empty, return year YYYY_additional.
+    #
+    # @example only year
+    #   DateBaseName.new.to_yyyy(Date.new(2014)) #=> "2014"
+    # @example year with additional text
+    #   DateBaseName.new.to_yyyy(Date.new(2014), additional: 'hoge') #=> "2014_hoge"
+    #
+    # @param [Date,DateTime] year target year
+    # @param [String] additional additional text.
+    #     If you want to get only year, you can omit this option.
+    # @return [String] year-based formated name
+    #
+    def to_yyyy(year, additional: '')
+      DateBaseNameValidators.validate_date(year)
+      v = year.strftime('%Y')
+      return v if additional.empty?
+      "#{v}_#{additional}"
+    end
+
+    # Get year-base formated name list.
+    # if additional is empty, return year YYYY.
+    # if additional is not empty, return year YYYY_additional.
+    #
+    # @example only year
+    #   DateBaseName.new.to_yyyymm_list(Date.new(2014), count: 4))
+    #   => ["2014","2015","2016","2017"]
+    # @example only year (omit count. default = 3)
+    #   DateBaseName.new.to_yyyymm_list(Date.new(2014)))
+    #   => ["2014","2015","2016"]
+    # @example year with additional text
+    #   DateBaseName.new.to_yyyymm_list(Date.new(2014), count: 4, additional: 'hoge')
+    #   => ["2014_hoge","2015_hoge","2016_hoge","2017_hoge"]
+    #
+    # @param [Date,DateTime] year year
+    # @param [Fixnum] count year count. default = 3.
+    # @param [String] additional additional text.
+    #     If you want to get only year, you can omit this option.
+    # @return [Array(String)] year-based formated names
+    def to_yyyy_list(year, count: 3, additional: '')
+      DateBaseNameValidators.validate_date(year)
+      count.times.with_object([]) do |i, memo|
+        memo << to_yyyy(year >> (i * 12), additional: additional)
+      end
+    end
+  end
+
+  # InvalidRange
+  class InvalidRange < StandardError; end
+
+  # Validators
+  class DateBaseNameValidators
+    def self.validate_date(date)
+      return if [Date, DateTime].include?(date.class)
+      fail ArgumentError, "invalid argument type #{date.class}"
+    end
+
+    def self.validate_date_range(date)
+      return if [Date, DateTime, Range].include?(date.class)
+      fail ArgumentError, "invalid argument type #{date.class}"
+    end
+  end
+end

data/lib/defoker/version.rb

@@ -0,0 +1,3 @@
+module Defoker
+  VERSION = '0.0.1'
+end

data/lib/defoker_core.rb

@@ -0,0 +1,113 @@
+# encoding: utf-8
+require 'date_base_name'
+require 'date'
+
+module Defoker
+  # rubocop disable LineLength
+
+  # Defoker Core
+  class Core
+    # Get today folder name
+    #
+    # @param [String] additional additional name
+    # @return [String] today folder name
+    def today(additional: '')
+      DateBaseName.new.to_yyyymmdd(Date.today, additional: additional)
+    end
+
+    # Get tommorow folder name
+    #
+    # @param [String] additional additional name
+    # @return [String] tommorow folder name
+    def tommorow(additional: '')
+      DateBaseName.new.to_yyyymmdd(Date.today + 1, additional: additional)
+    end
+
+    # Get yesterday folder name
+    #
+    # @param [String] additional additional name
+    # @return [String] yesterday folder name
+    def yesterday(additional: '')
+      DateBaseName.new.to_yyyymmdd(Date.today - 1, additional: additional)
+    end
+
+    # Get days folder name list
+    #
+    # @param [String] date yyyymmdd format string
+    # @param [String] additional additional name
+    # @return [String] yesterday folder name
+    def days(date, count: 3, additional: '')
+      date = Date.new(date[0..3].to_i, date[4..5].to_i, date[6..7].to_i)
+      DateBaseName.new.to_yyyymmdd_list(date, count: count, additional: additional)
+    end
+
+    # Get this month folder name
+    #
+    # @param [String] additional additional name
+    # @return [String] this month folder name
+    def this_month(additional: '')
+      DateBaseName.new.to_yyyymm(Date.today, additional: additional)
+    end
+
+    # Get next month folder name
+    #
+    # @param [String] additional additional name
+    # @return [String] next month folder name
+    def next_month(additional: '')
+      DateBaseName.new.to_yyyymm(Date.today >> 1, additional: additional)
+    end
+
+    # Get previous month folder name
+    #
+    # @param [String] additional additional name
+    # @return [String] previous month folder name
+    def previous_month(additional: '')
+      DateBaseName.new.to_yyyymm(Date.today << 1, additional: additional)
+    end
+
+    # Get months folder name list
+    #
+    # @param [String] month yyyymmdd format string
+    # @param [String] additional additional name
+    # @return [String] yesterday folder name
+    def months(month, count: 3, additional: '')
+      month = Date.new(month[0..3].to_i, month[4..5].to_i)
+      DateBaseName.new.to_yyyymm_list(month, count: count, additional: additional)
+    end
+
+    # Get this year folder name
+    #
+    # @param [String] additional additional name
+    # @return [String] this year folder name
+    def this_year(additional: '')
+      DateBaseName.new.to_yyyy(Date.today, additional: additional)
+    end
+
+    # Get next year folder name
+    #
+    # @param [String] additional additional name
+    # @return [String] next year folder name
+    def next_year(additional: '')
+      DateBaseName.new.to_yyyy(Date.today >> 12, additional: additional)
+    end
+
+    # Get previous year folder name
+    #
+    # @param [String] additional additional name
+    # @return [String] previous year folder name
+    def previous_year(additional: '')
+      DateBaseName.new.to_yyyy(Date.today << 12, additional: additional)
+    end
+
+    # Get years folder name list
+    #
+    # @param [String] year yyyymmdd format string
+    # @param [String] additional additional name
+    # @return [String] yesterday folder name
+    def years(year, count: 3, additional: '')
+      year = Date.new(year[0..3].to_i)
+      DateBaseName.new.to_yyyy_list(year, count: count, additional: additional)
+    end
+  end
+end
+# rubocop enable LineLength

data/rubocop-todo.yml

@@ -0,0 +1,26 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-10-02 00:42:00 +0900 using RuboCop version 0.21.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Documentation:
+  Enabled: false
+
+# Offense count: 1
+EmptyLinesAroundAccessModifier:
+  Enabled: false
+
+# Offense count: 38
+LineLength:
+  Max: 159
+
+# Offense count: 2
+RegexpLiteral:
+  MaxSlashes: 0
+
+# Offense count: 36
+UnusedMethodArgument:
+  Enabled: false

data/spec/date_base_name_spec.rb

@@ -0,0 +1,482 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'date_base_name'
+require 'date'
+
+describe Defoker::DateBaseName do
+  context :to_yyyymmdd do
+    cases = [
+      {
+        case_no: 1,
+        case_title: 'no addition, 1digit month, 1digit day case',
+        date: Date.new(2014, 9, 9),
+        additional: '',
+        expected: '20140909'
+      },
+      {
+        case_no: 2,
+        case_title: 'no addition, 2digit month, 1digit day case',
+        date: Date.new(2014, 12, 9),
+        additional: '',
+        expected: '20141209'
+      },
+      {
+        case_no: 3,
+        case_title: 'no addition, 1digit month, 2digit day case',
+        date: Date.new(2014, 9, 12),
+        additional: '',
+        expected: '20140912'
+      },
+      {
+        case_no: 4,
+        case_title: 'with addition case',
+        date: Date.new(2014, 9, 12),
+        additional: 'hoge',
+        expected: '20140912_hoge'
+      },
+      {
+        case_no: 5,
+        case_title: 'omit addition case',
+        date: Date.new(2014, 9, 12),
+        additional: nil,
+        expected: '20140912'
+      },
+      {
+        case_no: 6,
+        case_title: 'invalid date case',
+        date: '20140912',
+        expect_error: true
+      },
+      {
+        case_no: 7,
+        case_title: 'datetime case',
+        date: DateTime.new(2014, 9, 12),
+        additional: nil,
+        expected: '20140912'
+      }
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          defoker = Defoker::DateBaseName.new
+
+          # -- when --
+          actual =
+            if c[:additional]
+              defoker.to_yyyymmdd(c[:date], additional: c[:additional])
+            else
+              if c[:expect_error]
+                expect  { defoker.to_yyyymmdd(c[:date]) }.to raise_error(ArgumentError)
+                next
+              end
+              defoker.to_yyyymmdd(c[:date])
+            end
+
+          # -- then --
+          expect(actual).to eq(c[:expected])
+        ensure
+          case_after c
+        end
+      end
+
+      def case_before(c)
+        # implement each case before
+      end
+
+      def case_after(c)
+        # implement each case after
+      end
+    end
+  end
+
+  context :to_yyyymmdd_list do
+    cases = [
+      {
+        case_no: 1,
+        case_title: 'no addition 4days case',
+        day: Date.new(2014, 9, 9),
+        count: 4,
+        expected: %w(20140909 20140910 20140911 20140912)
+      },
+      {
+        case_no: 2,
+        case_title: 'no addition 1day case',
+        day: Date.new(2014, 9, 12),
+        count: 1,
+        expected: ['20140912']
+      },
+      {
+        case_no: 3,
+        case_title: 'with addition 4days case',
+        day: Date.new(2014, 9, 9),
+        count: 4,
+        additional: 'hoge',
+        expected: %w(20140909_hoge 20140910_hoge 20140911_hoge 20140912_hoge)
+      },
+      {
+        case_no: 4,
+        case_title: 'invalid date case',
+        day: '20140912',
+        expect_error: true
+      }
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          defoker = Defoker::DateBaseName.new
+
+          # -- when --
+          actual =
+            if c[:count] && c[:additional]
+              defoker.to_yyyymmdd_list(c[:day], count: c[:count], additional: c[:additional])
+            elsif c[:count]
+              defoker.to_yyyymmdd_list(c[:day], count: c[:count])
+            elsif c[:additional]
+              defoker.to_yyyymmdd_list(c[:day], additional: c[:additional])
+            else
+              if c[:expect_error]
+                expect  { defoker.to_yyyymmdd_list(c[:day]) }.to raise_error(ArgumentError)
+                next
+              end
+              defoker.to_yyyymmdd_list(c[:day])
+            end
+
+          # -- then --
+          expect(actual).to eq(c[:expected])
+        ensure
+          case_after c
+        end
+      end
+
+      def case_before(c)
+        # implement each case before
+      end
+
+      def case_after(c)
+        # implement each case after
+      end
+    end
+  end
+
+  context :to_yyyymm do
+    cases = [
+      {
+        case_no: 1,
+        case_title: 'no addition, 1digit month',
+        month: Date.new(2014, 9),
+        additional: '',
+        expected: '201409'
+      },
+      {
+        case_no: 2,
+        case_title: 'no addition, 2digit month',
+        month: Date.new(2014, 12),
+        additional: '',
+        expected: '201412'
+      },
+      {
+        case_no: 4,
+        case_title: 'with addition case',
+        month: Date.new(2014, 9),
+        additional: 'hoge',
+        expected: '201409_hoge'
+      },
+      {
+        case_no: 5,
+        case_title: 'omit addition case',
+        month: Date.new(2014, 9),
+        additional: nil,
+        expected: '201409'
+      },
+      {
+        case_no: 6,
+        case_title: 'invalid month case',
+        month: '201409',
+        expect_error: true
+      },
+      {
+        case_no: 7,
+        case_title: 'datetime case',
+        month: DateTime.new(2014, 9),
+        additional: nil,
+        expected: '201409'
+      }
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          defoker = Defoker::DateBaseName.new
+
+          # -- when --
+          actual =
+            if c[:additional]
+              defoker.to_yyyymm(c[:month], additional: c[:additional])
+            else
+              if c[:expect_error]
+                expect  { defoker.to_yyyymm(c[:month]) }.to raise_error(ArgumentError)
+                next
+              end
+              defoker.to_yyyymm(c[:month])
+            end
+
+          # -- then --
+          expect(actual).to eq(c[:expected])
+        ensure
+          case_after c
+        end
+      end
+
+      def case_before(c)
+        # implement each case before
+      end
+
+      def case_after(c)
+        # implement each case after
+      end
+    end
+  end
+
+  context :to_yyyymm_list do
+    cases = [
+      {
+        case_no: 1,
+        case_title: 'no addition 4months case',
+        month: Date.new(2014, 10),
+        count: 4,
+        expected: %w(201410 201411 201412 201501)
+      },
+      {
+        case_no: 2,
+        case_title: 'no addition 1month case',
+        month: Date.new(2014, 9),
+        count: 1,
+        expected: ['201409']
+      },
+      {
+        case_no: 3,
+        case_title: 'with addition 4months case',
+        month: Date.new(2014, 10),
+        count: 4,
+        additional: 'hoge',
+        expected: %w(201410_hoge 201411_hoge 201412_hoge 201501_hoge)
+      },
+      {
+        case_no: 4,
+        case_title: 'no addition, no count, 3months case',
+        month: Date.new(2014, 10),
+        expected: %w(201410 201411 201412)
+      },
+      {
+        case_no: 5,
+        case_title: 'invalid month case',
+        month: '201409',
+        expect_error: true
+      }
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          defoker = Defoker::DateBaseName.new
+
+          # -- when --
+          actual =
+            if c[:count] && c[:additional]
+              defoker.to_yyyymm_list(c[:month], count: c[:count], additional: c[:additional])
+            elsif c[:count]
+              defoker.to_yyyymm_list(c[:month], count: c[:count])
+            elsif c[:additional]
+              defoker.to_yyyymm_list(c[:month], additional: c[:additional])
+            else
+              if c[:expect_error]
+                expect  { defoker.to_yyyymm_list(c[:month]) }.to raise_error(ArgumentError)
+                next
+              end
+              defoker.to_yyyymm_list(c[:month])
+            end
+
+          # -- then --
+          expect(actual).to eq(c[:expected])
+        ensure
+          case_after c
+        end
+      end
+
+      def case_before(c)
+        # implement each case before
+      end
+
+      def case_after(c)
+        # implement each case after
+      end
+    end
+  end
+
+  context :to_yyyy do
+    cases = [
+      {
+        case_no: 1,
+        case_title: 'no addition case',
+        year: Date.new(2014),
+        additional: '',
+        expected: '2014'
+      },
+      {
+        case_no: 2,
+        case_title: 'with addition case',
+        year: Date.new(2014),
+        additional: 'hoge',
+        expected: '2014_hoge'
+      },
+      {
+        case_no: 3,
+        case_title: 'omit addition case',
+        year: Date.new(2014),
+        expected: '2014'
+      },
+      {
+        case_no: 4,
+        case_title: 'invalid year case',
+        year: '2014',
+        expect_error: true
+      },
+      {
+        case_no: 5,
+        case_title: 'datetime case',
+        year: DateTime.new(2014),
+        additional: nil,
+        expected: '2014'
+      }
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          defoker = Defoker::DateBaseName.new
+
+          # -- when --
+          actual =
+            if c[:additional]
+              defoker.to_yyyy(c[:year], additional: c[:additional])
+            else
+              if c[:expect_error]
+                expect  { defoker.to_yyyy(c[:year]) }.to raise_error(ArgumentError)
+                next
+              end
+              defoker.to_yyyy(c[:year])
+            end
+
+          # -- then --
+          expect(actual).to eq(c[:expected])
+        ensure
+          case_after c
+        end
+      end
+
+      def case_before(c)
+        # implement each case before
+      end
+
+      def case_after(c)
+        # implement each case after
+      end
+    end
+  end
+
+  context :to_yyyy_list do
+    cases = [
+      {
+        case_no: 1,
+        case_title: 'no addition 4years case',
+        year: Date.new(2014),
+        count: 4,
+        expected: %w(2014 2015 2016 2017)
+      },
+      {
+        case_no: 2,
+        case_title: 'no addition 1year case',
+        year: Date.new(2014),
+        count: 1,
+        expected: ['2014']
+      },
+      {
+        case_no: 3,
+        case_title: 'with addition 4years case',
+        year: Date.new(2014, 10),
+        count: 4,
+        additional: 'hoge',
+        expected: %w(2014_hoge 2015_hoge 2016_hoge 2017_hoge)
+      },
+      {
+        case_no: 4,
+        case_title: 'no addition, no count, 3years case',
+        year: Date.new(2014),
+        expected: %w(2014 2015 2016)
+      },
+      {
+        case_no: 5,
+        case_title: 'invalid year case',
+        from_or_range: '2014',
+        expect_error: true
+      }
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          defoker = Defoker::DateBaseName.new
+
+          # -- when --
+          actual =
+            if c[:count] && c[:additional]
+              defoker.to_yyyy_list(c[:year], count: c[:count], additional: c[:additional])
+            elsif c[:count]
+              defoker.to_yyyy_list(c[:year], count: c[:count])
+            elsif c[:additional]
+              defoker.to_yyyy_list(c[:year], additional: c[:additional])
+            else
+              if c[:expect_error]
+                expect  { defoker.to_yyyy_list(c[:year]) }.to raise_error(ArgumentError)
+                next
+              end
+              defoker.to_yyyy_list(c[:year])
+            end
+
+          # -- then --
+          expect(actual).to eq(c[:expected])
+        ensure
+          case_after c
+        end
+      end
+
+      def case_before(c)
+        # implement each case before
+      end
+
+      def case_after(c)
+        # implement each case after
+      end
+    end
+  end
+end