dummy_variables 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8575b36f61d0fa9dca9ceabbe599001e4babc672
+  data.tar.gz: 5acdd91625fa8adb4da377d1e7f21fb8597a3439
+SHA512:
+  metadata.gz: 90debadf9de9ee7b0ceb9c9c44a2e52fdcf9758d0a2456b6bf7e5db9ef080df3ed2053a600472193bd77ea5a47dacbc868b335e82ca3381d86fee06081d6e15f
+  data.tar.gz: e06d2d8d24c078ab1866b1dcf001c369f73e4e736431f5814292ee5f1b34bedd0221e11fc0524d8def73735585a5bbad089d1cb536a74297dc8a6a2f420bfb75

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

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 akihirokondo511@gmail.com. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in dummy_variables.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Akihiro Kondo
+
+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,211 @@
+# DummyVariables
+
+DummyVariables is a gem that generates dummy variables like 'if holiday then 1 else 0', 'if sunday then 1 else 0', etc. for each date.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dummy_variables'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dummy_variables
+
+## Usage
+
+```ruby
+require "dummy_variables"
+```
+
+```ruby
+cal = DummyVariables::Calendar.new("20140101", "20151231")
+File.open("cal.csv", "w") { |file| file.write(cal.to_csv_str) }
+```
+
+    $ head cal.csv
+
+```
+date,sun,mon,tue,wed,thu,fri,sat
+2014-01-01,0,0,0,1,0,0,0
+2014-01-02,0,0,0,0,1,0,0
+2014-01-03,0,0,0,0,0,1,0
+2014-01-04,0,0,0,0,0,0,1
+2014-01-05,1,0,0,0,0,0,0
+2014-01-06,0,1,0,0,0,0,0
+2014-01-07,0,0,1,0,0,0,0
+2014-01-08,0,0,0,1,0,0,0
+2014-01-09,0,0,0,0,1,0,0
+```
+
+```ruby
+File.open("cal.csv", "w") do |file|
+  file.write(
+    cal.to_csv_str(
+      [:sat, :sun], # select columns
+      options: { # add options
+        :write_headers => false,
+        :force_quotes => true
+      }
+    )
+  )
+end
+```
+
+    $ head cal.csv
+
+```
+"2014-01-01","0","0"
+"2014-01-02","0","0"
+"2014-01-03","0","0"
+"2014-01-04","1","0"
+"2014-01-05","0","1"
+"2014-01-06","0","0"
+"2014-01-07","0","0"
+"2014-01-08","0","0"
+"2014-01-09","0","0"
+"2014-01-10","0","0"
+```
+
+```
+$ cat <<EOF > config_file.yml
+holiday:
+  dates:
+    - 2014-01-01
+    - 2014-01-13
+    - 2014-02-11
+    - 2014-03-21
+    - 2014-04-29
+    - 2014-05-03
+    - 2014-05-04
+    - 2014-05-05
+    - 2014-05-06
+    - 2014-07-21
+    - 2014-09-15
+    - 2014-09-23
+    - 2014-10-13
+    - 2014-11-03
+    - 2014-11-23
+    - 2014-11-24
+    - 2014-12-23
+    - 2015-01-01
+    - 2015-01-12
+    - 2015-02-11
+    - 2015-03-21
+    - 2015-04-29
+    - 2015-05-03
+    - 2015-05-04
+    - 2015-05-05
+    - 2015-05-06
+    - 2015-07-20
+    - 2015-09-21
+    - 2015-09-22
+    - 2015-09-23
+    - 2015-10-12
+    - 2015-11-03
+    - 2015-11-23
+    - 2015-12-23
+break:
+  dates:
+    - 2014-01-02
+    - 2014-01-03
+    - 2014-08-13
+    - 2014-08-14
+    - 2014-08-15
+    - 2014-12-29
+    - 2014-12-30
+    - 2014-12-31
+    - 2015-01-02
+    - 2015-08-13
+    - 2015-08-14
+    - 2015-12-29
+    - 2015-12-30
+    - 2015-12-31
+EOF
+```
+
+```ruby
+cal = DummyVariables::Calendar.new("20140101", "20151231", config_file: "config_file.yml")
+File.open("cal.csv", "w") { |file| file.write(cal.to_csv_str) }
+```
+
+    $ head cal.csv
+
+```
+date,sun,mon,tue,wed,thu,fri,sat,holiday,break
+2014-01-01,0,0,0,1,0,0,0,1,0
+2014-01-02,0,0,0,0,1,0,0,0,1
+2014-01-03,0,0,0,0,0,1,0,0,1
+2014-01-04,0,0,0,0,0,0,1,0,0
+2014-01-05,1,0,0,0,0,0,0,0,0
+2014-01-06,0,1,0,0,0,0,0,0,0
+2014-01-07,0,0,1,0,0,0,0,0,0
+2014-01-08,0,0,0,1,0,0,0,0,0
+2014-01-09,0,0,0,0,1,0,0,0,0
+```
+
+JSON format supported, in addition to YAML format.
+
+You can also directly pass config data to DummyVariables::Calendar.new.
+
+```ruby
+config_data = {
+  "holiday" => {
+    "dates" => [
+      "2014-01-01", "2014-01-13", "2014-02-11", "2014-03-21", "2014-04-29", "2014-05-03", "2014-05-04",
+      "2014-05-05", "2014-05-06", "2014-07-21", "2014-09-15", "2014-09-23", "2014-10-13", "2014-11-03",
+      "2014-11-23", "2014-11-24", "2014-12-23", "2015-01-01", "2015-01-12", "2015-02-11", "2015-03-21",
+      "2015-04-29", "2015-05-03", "2015-05-04", "2015-05-05", "2015-05-06", "2015-07-20", "2015-09-21",
+      "2015-09-22", "2015-09-23", "2015-10-12", "2015-11-03", "2015-11-23", "2015-12-23"
+    ]
+  },
+  "break" => {
+    "dates" => [
+      "2014-01-02", "2014-01-03", "2014-08-13", "2014-08-14", "2014-08-15", "2014-12-29", "2014-12-30",
+      "2014-12-31", "2015-01-02", "2015-08-13", "2015-08-14", "2015-12-29", "2015-12-30", "2015-12-31"
+    ]
+  }
+}
+
+cal = DummyVariables::Calendar.new("20140101", "20151231", config_data: config_data)
+File.open("cal.csv", "w") { |file| file.write(cal.to_csv_str) }
+```
+
+    $ head cal.csv
+
+```
+date,sun,mon,tue,wed,thu,fri,sat,holiday,break
+2014-01-01,0,0,0,1,0,0,0,1,0
+2014-01-02,0,0,0,0,1,0,0,0,1
+2014-01-03,0,0,0,0,0,1,0,0,1
+2014-01-04,0,0,0,0,0,0,1,0,0
+2014-01-05,1,0,0,0,0,0,0,0,0
+2014-01-06,0,1,0,0,0,0,0,0,0
+2014-01-07,0,0,1,0,0,0,0,0,0
+2014-01-08,0,0,0,1,0,0,0,0,0
+2014-01-09,0,0,0,0,1,0,0,0,0
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/aknd/dummy_variables. 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 DummyVariables project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/aknd/dummy_variables/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dummy_variables/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dummy_variables"
+  spec.version       = DummyVariables::VERSION
+  spec.authors       = ["Akihiro Kondo"]
+  spec.email         = ["akihirokondo511@gmail.com"]
+
+  spec.summary       = %q{This is a gem that generates dummy variables for each date.}
+  spec.description   = %q{This is a gem that generates dummy variables like 'if holiday then 1 else 0' for each date.}
+  spec.homepage      = "https://github.com/aknd/dummy_variables"
+  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"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_dependency "deep_merge", "~> 1.0", ">= 1.0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/dummy_variables.rb

@@ -0,0 +1,5 @@
+require "dummy_variables/version"
+require "dummy_variables/calendar"
+
+module DummyVariables
+end

data/lib/dummy_variables/calendar.rb

@@ -0,0 +1,50 @@
+require "date"
+require "csv"
+require "yaml"
+require "json"
+require "deep_merge"
+require "dummy_variables/data_date"
+
+module DummyVariables
+  class Calendar
+    attr_reader :dates
+
+    def initialize(start_date, end_date, date_format="%Y-%m-%d", config_data: {}, config_file: "")
+      custom_dates = config_file.to_s.empty? ? {} : load_config_file(config_file)
+      custom_dates.deep_merge! config_data if config_data.is_a?(Hash)
+      @dates = (Date.parse(start_date)..Date.parse(end_date)).map do |date|
+        vars = {}
+        custom_dates.each do |k, v|
+          next unless v.key? "dates"
+          vars[k] = v["dates"].map { |d| d.is_a?(Date) ? d : Date.parse(d) }.include?(date) ? 1 : 0
+        end
+        DummyVariables::DataDate.new(date.strftime(date_format), vars)
+      end
+    end
+
+    def to_csv_str(columns=nil, encoding: "Shift_JIS", options: {})
+      options[:headers] = @dates.size == 0 ? [] : @dates[0].to_hash(columns).keys
+      options[:write_headers] = true unless options.key?(:write_headers)
+      CSV.generate(options) { |csv|
+        @dates.each { |data_date| csv << data_date.to_hash(columns).values }
+      }.encode(encoding, invalid: :replace, undef: :replace)
+    end
+
+    private
+
+    def load_config_file(config_file)
+      begin
+        case File.extname(config_file)
+        when ".yml", ".yaml"
+          YAML.load_file(config_file)
+        when ".json"
+          File.open(config_file) { |file| JSON.load(file) }
+        else
+          raise "configuration file needs to be formatted as JSON or YAML"
+        end
+      rescue => e
+        p e.message; {}
+      end
+    end
+  end
+end

data/lib/dummy_variables/data_date.rb

@@ -0,0 +1,21 @@
+module DummyVariables
+  class DataDate
+    WDAYS = { "0" => "sun", "1" => "mon", "2" => "tue", "3" => "wed", "4" => "thu", "5" => "fri", "6" => "sat" }
+
+    attr_reader :date
+
+    def initialize(date, vars)
+      @date = date
+      @vars = WDAYS.values.inject({}) { |h, e| h[e] = 0; h }
+      @vars[WDAYS[Date.parse(@date).wday.to_s]] = 1
+      @vars.merge! vars
+      @vars.keys.each { |k| self.class.send(:define_method, k) { @vars[k] } }
+    end
+
+    def to_hash(keys=nil)
+      keys = keys.nil? ? @vars.keys : keys.map(&:to_s) & @vars.keys
+      keys.insert(0, "date")
+      keys.inject({}) { |h, e| h[e] = send(e); h }
+    end
+  end
+end

data/lib/dummy_variables/version.rb

@@ -0,0 +1,3 @@
+module DummyVariables
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: dummy_variables
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Akihiro Kondo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This is a gem that generates dummy variables like 'if holiday then 1
+  else 0' for each date.
+email:
+- akihirokondo511@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dummy_variables.gemspec
+- lib/dummy_variables.rb
+- lib/dummy_variables/calendar.rb
+- lib/dummy_variables/data_date.rb
+- lib/dummy_variables/version.rb
+homepage: https://github.com/aknd/dummy_variables
+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.8
+signing_key: 
+specification_version: 4
+summary: This is a gem that generates dummy variables for each date.
+test_files: []