at_coder_friends 0.6.9 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc8c9e5d2e8f2f243d7e520c88186cc62b46296a3e1b5d7a60673d8a208dd7ec
-  data.tar.gz: 732ab4cbadae2e8e8a1a51e3928fc0bb7f58da4738c770c93d82f5b6262f76b4
+  metadata.gz: bada11ce4daaea235dde05940e0e6d75dc07c64d964b0192e3f9d789346bdc01
+  data.tar.gz: 4324be344fdd848ea9397fc9b21bfa542567f5d9ced110fefc188c7f787c656e
 SHA512:
-  metadata.gz: df86a0c84321098080ba9ad9ef32b6b8f413621ecd90c297fc27d65f36d8d159e7cbfe03c54cce0aa9560ce2b33841c9afa46eb5fbff33bb977d3c0dcfb186bb
-  data.tar.gz: fbc249260ea37187c833ff102002feee9781dc6eecdfd175d4fd06ccf3f33d7a706431353c39a4126d9761825f50b3050b695b02353558594ef93ab07a4dede0
+  metadata.gz: 2612df7b0bbdf727dc76aca694a9d02f8278eebfd2683b4e13c06cfa18a18abb4844d474df393651e04a56a07328fc5274ac79a160c7475f4ec01e97474cc305
+  data.tar.gz: 765962cc818da264ff9655eef7cd73e13c4579e03d1ff2c253b4934b1f84bf581484b46d925d7754a087ea916d51b89b8785fec68f4b8ec2362f85f048ec8c00

data/.gitattributes

@@ -1 +1 @@
-spec/mocks/* linguist-vendored
+spec/mocks/** linguist-vendored

data/.github/workflows/ruby.yml

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.5', '2.7']
+        ruby-version: ['2.7', '3.0', '3.2']
 
     steps:
     - uses: actions/checkout@v2
@@ -30,3 +30,9 @@ jobs:
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Run tests
       run: script -e -c "bundle exec rspec"
+      env:
+        COVERAGE: true
+    - name: publish code coverage
+      uses: paambaati/codeclimate-action@v3.0.0
+      env:
+        CC_TEST_REPORTER_ID: cb942bcc168feb78c43c506364d5344c5ec9a46a0b68dc66acb581e77c981ff1

data/.gitignore

@@ -19,3 +19,6 @@
 
 # regression environment
 /regression
+
+# Visual Studio Code local settings
+.vscode/

data/.rubocop.yml

@@ -1,7 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
   Exclude:
     - 'templates/**/*'
     - 'spec/fixtures/**/*'

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## master (unreleased)
 
+## 0.7.0 (2023-05-12)
+### Added
+- add AnyBuiltin Generator
+- add file extension to generator settings
+- enable multiple configuration for one generator
+- add CBuiltin Generator
+- add Ruby3.2 to target version.
+- add C# and Java templates for AnyBuiltin Generator
+### Deleted
+- drop Ruby2.6 from target version.
+### Changed
+- generators : externalize code fragments to YAML
+
 ## 0.6.9 (2021-12-25)
 ### Added
 - input_format.rb : \hspace{...}, \text{...} support
@@ -67,7 +80,7 @@
 
 ## 0.6.2 (2019-11-18)
 ### Added
-- add ```check-and-go``` command.
+- add `check-and-go` command.
 
 ### Changed
 - Enhancement in input format parser.
@@ -87,7 +100,7 @@
 - Add settings about source generation.
 
 ### Changed
-- Treat all ```A_*.in``` format files as sample input data
+- Treat all `A_*.in` format files as sample input data
 
 ## 0.5.2 (2019-10-14)
 ### Fixed
@@ -103,7 +116,7 @@
 
 ## 0.5.0 (2019-10-04)
 ### Added
-- User/password setting in ```.at_coder_friends.yml``` is no longer required.
+- User/password setting in `.at_coder_friends.yml` is no longer required.
 - Saving and restoring session feature.
 
 ## 0.4.0 (2019-09-16)
@@ -112,4 +125,4 @@
 
 ## 0.3.3 (2019-09-01)
 ### Added
-- Add ```open-contest-page``` command.
+- Add `open-contest-page` command.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    at_coder_friends (0.6.9)
+    at_coder_friends (0.7.0)
       colorize (~> 0.8.1)
       launchy (>= 2.4.3)
       mechanize (~> 2.0)
@@ -9,10 +9,10 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
     colorize (0.8.1)
-    connection_pool (2.2.5)
+    connection_pool (2.4.0)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
@@ -20,11 +20,12 @@ GEM
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     hashdiff (1.0.1)
-    http-cookie (1.0.4)
+    http-cookie (1.0.5)
       domain_name (~> 0.5)
-    launchy (2.5.0)
-      addressable (~> 2.7)
-    mechanize (2.8.3)
+    json (2.6.3)
+    launchy (2.5.2)
+      addressable (~> 2.8)
+    mechanize (2.9.1)
       addressable (~> 2.8)
       domain_name (~> 0.5, >= 0.5.20190701)
       http-cookie (~> 1.0, >= 1.0.3)
@@ -37,62 +38,58 @@ GEM
       webrobots (~> 0.1.2)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.1115)
-    mini_portile2 (2.6.1)
+    mime-types-data (3.2023.0218.1)
     net-http-digest_auth (1.4.1)
-    net-http-persistent (4.0.1)
+    net-http-persistent (4.0.2)
       connection_pool (~> 2.2)
-    nokogiri (1.12.5)
-      mini_portile2 (~> 2.6.1)
+    nokogiri (1.14.3-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.12.5-x64-mingw32)
+    nokogiri (1.14.3-x86_64-linux)
       racc (~> 1.4)
-    public_suffix (4.0.6)
-    racc (1.6.0)
+    public_suffix (5.0.1)
+    racc (1.6.2)
     rake (13.0.6)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
     rubyntlm (0.6.3)
-    simplecov (0.21.2)
+    simplecov (0.17.1)
       docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.8)
-    unf_ext (0.0.8-x64-mingw32)
-    webmock (3.14.0)
+    unf_ext (0.0.8.2)
+    webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    webrick (1.7.0)
+    webrick (1.8.1)
     webrobots (0.1.2)
 
 PLATFORMS
-  ruby
-  x64-mingw32
+  arm64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   at_coder_friends!
   bundler (~> 2.0)
   rake (~> 13.0)
   rspec (~> 3.0)
-  simplecov (~> 0.10)
+  simplecov (~> 0.10, < 0.18)
   webmock (~> 3.0)
 
 BUNDLED WITH
-   2.2.32
+   2.4.12

data/README.md

@@ -20,7 +20,7 @@ AtCoderFriends automates tasks about [AtCoder](https://atcoder.jp/) programming
 
 ## Dependencies
 
-- Ruby 2.5 or newer
+- Ruby 2.7 or newer
 - [Mechanize](https://github.com/sparklemotion/mechanize)
 
 ## Installation
@@ -84,107 +84,26 @@ at_coder_friends check-and-go  /path/to/contest/source_file
 ### Naming convention
 
 - Contest folder name will be used in the contest site URL.
-  For example, if ```arc001``` folder is specified, AtCoderFriends will use  ```https://atcoder.jp/contests/arc001/```.
-- Source file should be named ```[problem ID].[language specific extension]```(e.g. ```A.rb```),
+  For example, if `arc001` folder is specified, AtCoderFriends will use  `https://atcoder.jp/contests/arc001/`.
+- Source file should be named `[problem ID].[language specific extension]`(e.g. `A.rb`),
   in order to let AtCoderFriends find test cases or fill the submission form.
-- Suffixes (start with underscore) may be added to the file name (e.g. ```A_v2.rb```),
+- Suffixes (start with underscore) may be added to the file name (e.g. `A_v2.rb`),
   so that you can try multiple codes for one problem.
 
 ## Notes
 
 - Compilation is not supported.
-- Source generator supports Ruby and C++ in default, and can be added by plugin.
+- Source generator supports Ruby and C/C++ in default, and can be added by plugin.
 - Test runner and code submission are supported in 36 languages.
 
 
 ## Configuration
 
-See [CONFIGURATION.md](docs/CONFIGURATION.md) for details.
-
-## For Sublime Text user
-
-It is convenient to use AtCoderFriends from Sublime Text plugin.
-
-- [sublime_at_coder_friends](https://github.com/nejiko96/sublime_at_coder_friends)
-
-## For Visual Studio Code user
-
-- Run **Configure Tasks** from the global Terminal menu.
-- Select the **Create tasks.json file from template** entry.
-- Select **Others** from the list.
-- Add following settings to ```tasks.json```.
-
-```JSON
-{
-  "version": "2.0.0",
-  "tasks": [
-    {
-      "label": "AtCoderFriends:New Contest",
-      "type": "shell",
-      "command": "at_coder_friends",
-      "args": [
-        "setup",
-        "${input:contestName}"
-      ],
-      "problemMatcher": [],
-      "group": "none"
-    },
-    {
-      "label": "AtCoderFriends:Test One",
-      "type": "shell",
-      "command": "at_coder_friends",
-      "args": [
-        "test-one",
-        "${file}"
-      ],
-      "problemMatcher": [],
-      "group": "none"
-    },
-    {
-      "label": "AtCoderFriends:Test All",
-      "type": "shell",
-      "command": "at_coder_friends",
-      "args": [
-        "test-all",
-        "${file}"
-      ],
-      "problemMatcher": [],
-      "group": "none"
-    },
-    {
-      "label": "AtCoderFriends:Submit",
-      "type": "shell",
-      "command": "at_coder_friends",
-      "args": [
-        "submit",
-        "${file}"
-      ],
-      "problemMatcher": [],
-      "group": "none",
-    },
-    {
-      "label": "AtCoderFriends:Check & Go",
-      "type": "shell",
-      "command": "at_coder_friends",
-      "args": [
-        "check-and-go",
-        "${file}"
-      ],
-      "problemMatcher": [],
-      "group": "none",
-    },
-    ...
-  ],
-  "inputs": [
-    {
-      "id": "contestName",
-      "type": "promptString",
-      "default": "",
-      "description": "Contest Name"
-    }
-  ]
-}
-```
+See [Wiki](https://github.com/nejiko96/at_coder_friends/wiki/Configuration-details) for details.
+
+## Customizing editor
+
+See [Wiki](https://github.com/nejiko96/at_coder_friends/wiki/Customizing-editor) for details.
 
 ## Development
 

data/at_coder_friends.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.metadata = {
     'homepage_uri' => spec.homepage,
@@ -44,6 +44,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'simplecov', '~> 0.10'
+  spec.add_development_dependency 'simplecov', '~> 0.10', '< 0.18'
   spec.add_development_dependency 'webmock', '~> 3.0'
 end

data/lib/at_coder_friends/cli.rb

@@ -67,30 +67,15 @@ module AtCoderFriends
 
     def exec_command(command, path, *args)
       @ctx = Context.new(@options, path)
-      case command
-      when 'setup'
-        setup
-      when 'test-one'
-        test_one(*args)
-      when 'test-all'
-        test_all
-      when 'submit'
-        submit
-      when 'check-and-go'
-        check_and_go
-      when 'judge-one'
-        judge_one(*args)
-      when 'judge-all'
-        judge_all
-      when 'open-contest'
-        open_contest
-      else
-        raise ParamError, "unknown command: #{command}"
-      end
+
+      mtd = "command_#{command.gsub('-', '_')}"
+      raise ParamError, "unknown command: #{command}" unless respond_to?(mtd)
+
+      send(mtd, *args)
       ctx.post_process
     end
 
-    def setup
+    def command_setup
       path = ctx.path
       raise AppError, "#{path} is not empty." \
         if Dir.exist?(path) && !Dir["#{path}/*"].empty?
@@ -102,16 +87,16 @@ module AtCoderFriends
       end
     end
 
-    def test_one(id = '001')
+    def command_test_one(id = '001')
       ctx.sample_test_runner.test_one(id)
     end
 
-    def test_all
+    def command_test_all
       ctx.sample_test_runner.test_all
       ctx.verifier.verify
     end
 
-    def submit
+    def command_submit
       vf = ctx.verifier
       raise AppError, "#{vf.file} has not been tested." unless vf.verified?
 
@@ -120,7 +105,7 @@ module AtCoderFriends
       open_submission_list
     end
 
-    def check_and_go
+    def command_check_and_go
       vf = ctx.verifier
       if ctx.sample_test_runner.test_all
         # submit automatically
@@ -133,15 +118,15 @@ module AtCoderFriends
       end
     end
 
-    def judge_one(id = '')
+    def command_judge_one(id = '')
       ctx.judge_test_runner.judge_one(id)
     end
 
-    def judge_all
+    def command_judge_all
       ctx.judge_test_runner.judge_all
     end
 
-    def open_contest
+    def command_open_contest
       Launchy.open(ctx.scraping_agent.contest_url)
     end
 

data/lib/at_coder_friends/config_loader.rb

@@ -61,8 +61,7 @@ module AtCoderFriends
       end
 
       def load_yaml(path)
-        yaml = File.read(path, encoding: Encoding::UTF_8)
-        YAML.safe_load(yaml, [], [], false, path) || {}
+        YAML.load_file(path) || {}
       rescue Errno::ENOENT
         raise ConfigNotFoundError,
               "Configuration file not found: #{path}"

data/lib/at_coder_friends/generator/any_builtin.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module AtCoderFriends
+  module Generator
+    # generates source from template
+    class AnyBuiltin < Base
+      include ConstFragmentMixin
+      include DeclFragmentMixin
+      include InputFragmentMixin
+
+      ACF_HOME = File.realpath(File.join(__dir__, '..', '..', '..'))
+      TMPL_DIR = File.join(ACF_HOME, 'templates')
+      TEMPLATE = File.join(TMPL_DIR, 'any_builtin.md.erb')
+      FRAGMENTS = File.join(TMPL_DIR, 'any_builtin_fragments.yml')
+      ATTRS = Attributes.new(:md, TEMPLATE, FRAGMENTS)
+
+      def attrs
+        ATTRS
+      end
+    end
+  end
+end

data/lib/at_coder_friends/generator/base.rb

@@ -1,13 +1,17 @@
 # frozen_string_literal: true
 
+require 'yaml'
 require 'erb'
 
 module AtCoderFriends
   module Generator
-    Attributes = Struct.new(:file_ext, :default_template)
+    Attributes = Struct.new(:file_ext, :template, :fragments)
 
     # common behavior of generators
     class Base
+      ACF_HOME = File.realpath(File.join(__dir__, '..', '..', '..'))
+      TMPL_DIR = File.join(ACF_HOME, 'templates')
+
       attr_reader :cfg, :pbm
 
       def initialize(cfg = nil)
@@ -15,21 +19,36 @@ module AtCoderFriends
       end
 
       def process(pbm)
-        pbm.add_src(attrs.file_ext, generate(pbm))
+        pbm.add_src(config_file_ext, generate(pbm))
       end
 
       def generate(pbm)
         @pbm = pbm
-        src = File.read(select_template)
-        src = ERB.new(src, safe_level = nil, trim_mode = '-').result(binding)
+        template = File.read(config_template)
+        src = ERB.new(template, trim_mode: '-').result(binding)
         src = render(src) if respond_to?(:render)
         src
       end
 
-      def select_template
-        cfg['default_template'] || attrs.default_template
+      def fragments
+        @fragments ||= YAML.load_file(config_fragments)
+      end
+
+      def config_file_ext
+        cfg['file_ext']&.to_sym || attrs.file_ext
       end
 
+      def config_template
+        template = cfg['template'] || cfg['default_template'] || attrs.template
+        template.sub(/\A@/, TMPL_DIR)
+      end
+
+      def config_fragments
+        fragments = cfg['fragments'] || attrs.fragments
+        fragments.sub(/\A@/, TMPL_DIR)
+      end
+
+      # deprecated, use ERB syntax
       def embed_lines(src, pat, lines)
         re = Regexp.escape(pat)
         src.gsub(
@@ -38,5 +57,35 @@ module AtCoderFriends
         )
       end
     end
+
+    module ConstFragmentMixin
+      def gen_consts
+        pbm.constants.map { |c| gen_const(c) }
+      end
+
+      def gen_const(c)
+        ConstFragment.new(c, fragments['constant']).generate
+      end
+    end
+
+    module DeclFragmentMixin
+      def gen_decls
+        pbm.formats.map { |inpdef| gen_decl(inpdef).split("\n") }.flatten
+      end
+
+      def gen_decl(inpdef)
+        InputFormatFragment.new(inpdef, fragments['declaration']).generate
+      end
+    end
+
+    module InputFragmentMixin
+      def gen_inputs
+        pbm.formats.map { |inpdef| gen_input(inpdef).split("\n") }.flatten
+      end
+
+      def gen_input(inpdef)
+        InputFormatFragment.new(inpdef, fragments['input']).generate
+      end
+    end
   end
 end

data/lib/at_coder_friends/generator/c_builtin.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module AtCoderFriends
+  module Generator
+    # generates C source from problem description
+    class CBuiltin < Base
+      include ConstFragmentMixin
+      include DeclFragmentMixin
+      include InputFragmentMixin
+
+      ACF_HOME = File.realpath(File.join(__dir__, '..', '..', '..'))
+      TMPL_DIR = File.join(ACF_HOME, 'templates')
+      TEMPLATE = File.join(TMPL_DIR, 'c_builtin.c.erb')
+      FRAGMENTS = File.join(TMPL_DIR, 'c_builtin_fragments.yml')
+      ATTRS = Attributes.new(:c, TEMPLATE, FRAGMENTS)
+
+      def attrs
+        ATTRS
+      end
+    end
+  end
+end