syobocalite 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c66235b54db0a2f1bd0140ebba1f78a7a50ddf7f9f3ac80c8e0326fbd7335551
-  data.tar.gz: df1a38d0ce3ca6e543a5e7dc5c7bcbe4809f5e43fa04735bd78fd528bb71607f
+  metadata.gz: 54e715bc7979d257cd27952ad2591999411c2fbff9a5bf89ae74e68ef2130507
+  data.tar.gz: 838b7257de52a103e8d12f04892600020edd0eeb2845b94da847508022ec2634
 SHA512:
-  metadata.gz: 5473becc58c3ddd2d13f96032db08b6dc00460b3672eb84f83f3c17e9bf6e70184bba6028f5bc5a529f581861ee4f41ce92f1900e01cebcacd22a8dcb24efbaf
-  data.tar.gz: 676908cea8efdffdb64195561a791700f8be8a71b6dcad3869ae104ca0d97f872d5da38afdc83152e5b7ac583c9074d0b735fdd7c2d26426e67dc1e937864220
+  metadata.gz: 3df0024a0d4337855bf8b6c51e51b3a7859ec97b5f3030b4bca2695057e88cb9640aaa443adbd27508f8fb3830c928284cd42f217247a6c741c476a9f651ec6c
+  data.tar.gz: 745e50fe71acf628cd6dba421b44327234179a099702ac626b7e6718d834cdb51ce2e02f8b7b023beb2ef80445b92223a07d79d007650c9e31e78d1d72307134

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+# c.f. https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+version: 2
+
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    assignees:
+      - sue445

data/.github/workflows/pages.yml

@@ -0,0 +1,59 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches:
+      - master
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby
+          bundler-cache: true
+
+      - run: bundle exec yard
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: './doc'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@main
+
+      - name: Slack Notification (not success)
+        uses: act10ns/slack@v2
+        if: "! success()"
+        continue-on-error: true
+        with:
+          status: ${{ job.status }}
+          webhook-url: ${{ secrets.SLACK_WEBHOOK }}

data/.github/workflows/test.yml

@@ -12,82 +12,59 @@ on:
   schedule:
     - cron: "0 10 * * 5" # JST 19:00 (Fri)
 
-env:
-  CI: "true"
-
 jobs:
   test:
     runs-on: ubuntu-latest
 
-    container: ${{ matrix.ruby }}
-
     strategy:
       fail-fast: false
 
       matrix:
         ruby:
-          - ruby:2.5
-          - ruby:2.6
-          - ruby:2.7
-          - ruby:3.0
-          - rubylang/ruby:master-nightly-bionic
-        include:
-          - ruby: rubylang/ruby:master-nightly-bionic
-            allow_failures: "true"
+          - "2.5"
+          - "2.6"
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
+          - "3.3"
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-
-      - name: Cache vendor/bundle
-        uses: actions/cache@v1
-        id: cache_gem
+      - uses: ruby/setup-ruby@v1
         with:
-          path: vendor/bundle
-          key: v1-gem-${{ runner.os }}-${{ matrix.ruby }}-${{ github.sha }}
-          restore-keys: |
-            v1-gem-${{ runner.os }}-${{ matrix.ruby }}-
-        continue-on-error: ${{ matrix.allow_failures == 'true' }}
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          cache-version: ${{ matrix.gemfile }}
 
-      - name: bundle update
-        run: |
-          set -xe
-          bundle config path vendor/bundle
-          bundle update --jobs $(nproc) --retry 3
-        continue-on-error: ${{ matrix.allow_failures == 'true' }}
+      - run: bundle update --jobs $(nproc) --retry 3
 
       - name: Setup Code Climate Test Reporter
         uses: aktions/codeclimate-test-reporter@v1
         with:
           codeclimate-test-reporter-id: ${{ secrets.CC_TEST_REPORTER_ID }}
           command: before-build
-        if: matrix.ruby >= 'ruby:2.4'
         continue-on-error: true
 
-      - name: Run test
-        run: |
-          set -xe
-          bundle exec rspec
-        continue-on-error: ${{ matrix.allow_failures == 'true' }}
+      - run: bundle exec rspec
 
       - name: Teardown Code Climate Test Reporter
         uses: aktions/codeclimate-test-reporter@v1
         with:
           codeclimate-test-reporter-id: ${{ secrets.CC_TEST_REPORTER_ID }}
           command: after-build
-        if: matrix.ruby >= 'ruby:2.4' && always()
+        if: always()
         continue-on-error: true
 
       - name: Slack Notification (not success)
-        uses: lazy-actions/slatify@master
+        uses: act10ns/slack@v2
         if: "! success()"
         continue-on-error: true
         with:
-          job_name: ${{ format('*build* ({0})', matrix.ruby) }}
-          type: ${{ job.status }}
-          icon_emoji: ":octocat:"
-          url: ${{ secrets.SLACK_WEBHOOK }}
-          token: ${{ secrets.GITHUB_TOKEN }}
+          status: ${{ job.status }}
+          webhook-url: ${{ secrets.SLACK_WEBHOOK }}
+          matrix: ${{ toJson(matrix) }}
 
   notify:
     needs:
@@ -97,12 +74,9 @@ jobs:
 
     steps:
       - name: Slack Notification (success)
-        uses: lazy-actions/slatify@master
+        uses: act10ns/slack@v2
         if: always()
         continue-on-error: true
         with:
-          job_name: '*build*'
-          type: ${{ job.status }}
-          icon_emoji: ":octocat:"
-          url: ${{ secrets.SLACK_WEBHOOK }}
-          token: ${{ secrets.GITHUB_TOKEN }}
+          status: ${{ job.status }}
+          webhook-url: ${{ secrets.SLACK_WEBHOOK }}

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## master
-[full changelog](https://github.com/sue445/syobocalite/compare/v1.0.1...master)
+[full changelog](https://github.com/sue445/syobocalite/compare/v1.1.0...master)
+
+## 1.1.0
+[full changelog](https://github.com/sue445/syobocalite/compare/v1.0.1...v1.1.0)
+
+* Add `#flag`,`#remark?`, `#new?`, `#final?` and `#re_air?` to `Syobocalite::Program`
+  * https://github.com/sue445/syobocalite/pull/41
 
 ## 1.0.1
 [full changelog](https://github.com/sue445/syobocalite/compare/v1.0.0...v1.0.1)

data/README.md

@@ -42,11 +42,11 @@ end_at   = Time.zone.parse("2018-10-07 09:00:00")
 Syobocalite.search(start_at: start_at, end_at: end_at)
 ```
 
-`Syobocalite.search` returns `Array` of [`Syobocalite::Program`](lib/syobocalite/program.rb)
+`Syobocalite.search` returns `Array` of [Syobocalite::Program](lib/syobocalite/program.rb)
 
 ## vs. [syobocal](https://github.com/xmisao/syobocal)
 * Supports only `http://cal.syoboi.jp/cal_chk.php`
-* Supports `Time` and [`ActiveSupport::TimeWithZone`](https://api.rubyonrails.org/classes/ActiveSupport/TimeWithZone.html)
+* Supports `Time` and [ActiveSupport::TimeWithZone](https://api.rubyonrails.org/classes/ActiveSupport/TimeWithZone.html)
 * Returns array of PORO (NOT array of `Hash`)
 
 ## Development

data/lib/syobocalite/db_client.rb

@@ -0,0 +1,27 @@
+module Syobocalite
+  # API client for https://cal.syoboi.jp/db.php
+  # @see https://docs.cal.syoboi.jp/spec/db.php/
+  class DbClient
+    # Get program's flag
+    # @param tid [Integer]
+    # @param pid [Integer]
+    # @return [Integer]
+    # @see https://docs.cal.syoboi.jp/spec/proginfo-flag/
+    def get_program_flag(tid:, pid:)
+      params = {
+        "Command" => "ProgLookup",
+        "Fields" => "Flag",
+        "TID" => tid,
+        "PID" => pid,
+      }
+
+      headers = {
+        "User-Agent" => Syobocalite.user_agent,
+      }
+
+      xml = URI.open("https://cal.syoboi.jp/db.php?#{params.to_param}", headers).read
+      response = MultiXml.parse(xml)
+      response["ProgLookupResponse"]["ProgItems"]["ProgItem"]["Flag"].to_i
+    end
+  end
+end

data/lib/syobocalite/program.rb

@@ -73,6 +73,41 @@ module Syobocalite
     alias_method :story_number,  :count
     alias_method :story_number=, :count=
 
+    # Get program's flag
+    # @return [Integer]
+    # @see https://docs.cal.syoboi.jp/spec/proginfo-flag/
+    def flag
+      @flag ||= Syobocalite::DbClient.new.get_program_flag(tid: tid, pid: pid)
+    end
+
+    # Whether contains remark
+    # @return [Boolean]
+    # @see https://docs.cal.syoboi.jp/spec/proginfo-flag/
+    def remark?
+      flag & 0x01 != 0
+    end
+
+    # Whether new program
+    # @return [Boolean]
+    # @see https://docs.cal.syoboi.jp/spec/proginfo-flag/
+    def new?
+      flag & 0x02 != 0
+    end
+
+    # Whether final program
+    # @return [Boolean]
+    # @see https://docs.cal.syoboi.jp/spec/proginfo-flag/
+    def final?
+      flag & 0x04 != 0
+    end
+
+    # Whether re-air program
+    # @return [Boolean]
+    # @see https://docs.cal.syoboi.jp/spec/proginfo-flag/
+    def re_air?
+      flag & 0x08 != 0
+    end
+
     # @param attrs [Hash]
     #
     # @return [Syobocalite::Program]

data/lib/syobocalite/version.rb

@@ -1,3 +1,3 @@
 module Syobocalite
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/syobocalite.rb

@@ -1,5 +1,6 @@
 require "syobocalite/version"
 require "syobocalite/program"
+require "syobocalite/db_client"
 require "active_support/all"
 require "multi_xml"
 require "open-uri"
@@ -12,7 +13,7 @@ module Syobocalite
   #
   # @return [Array<Program>]
   #
-  # @see https://sites.google.com/site/syobocal/spec/cal_chk-php
+  # @see https://docs.cal.syoboi.jp/spec/cal_chk.php/
   def self.search(start_at:, end_at:)
     xml = fetch(start_at: start_at, end_at: end_at)
     response = MultiXml.parse(xml)
@@ -25,6 +26,11 @@ module Syobocalite
     end
   end
 
+  # @return [String]
+  def self.user_agent
+    "Syobocalite v#{Syobocalite::VERSION}"
+  end
+
   def self.fetch(start_at:, end_at:)
     params = {}
 
@@ -38,7 +44,7 @@ module Syobocalite
     end
 
     headers = {
-      "User-Agent" => "Syobocalite v#{Syobocalite::VERSION}",
+      "User-Agent" => user_agent,
     }
 
     URI.open("http://cal.syoboi.jp/cal_chk.php?#{params.to_param}", headers).read

data/syobocalite.gemspec

@@ -16,15 +16,11 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.3.0"
 
-  if spec.respond_to?(:metadata)
-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = spec.homepage
-    spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
-    spec.metadata["rubygems_mfa_required"] = "true"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "https://sue445.github.io/syobocalite/"
+  spec.metadata["rubygems_mfa_required"] = "true"
 
   # 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.
@@ -41,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "multi_xml"
 
   spec.add_development_dependency "bundler", ">= 1.16"
-  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "coveralls_reborn"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syobocalite
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - sue445
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-20 00:00:00.000000000 Z
+date: 2024-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -158,6 +158,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".coveralls.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/pages.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
@@ -170,6 +172,7 @@ files:
 - bin/console
 - bin/setup
 - lib/syobocalite.rb
+- lib/syobocalite/db_client.rb
 - lib/syobocalite/program.rb
 - lib/syobocalite/version.rb
 - syobocalite.gemspec
@@ -180,6 +183,7 @@ metadata:
   homepage_uri: https://github.com/sue445/syobocalite
   source_code_uri: https://github.com/sue445/syobocalite
   changelog_uri: https://github.com/sue445/syobocalite/blob/master/CHANGELOG.md
+  documentation_uri: https://sue445.github.io/syobocalite/
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -196,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Lite client for Syoboi calendar