nicorepo 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d0c8ac38ef205c58bc61e5014580cf41126433f
-  data.tar.gz: 64fe13068e72c8edae3d9feb8ddab9e3f5fcf1d1
+  metadata.gz: 8aa463841c71be718b4908e77b2450805fdfa8b9
+  data.tar.gz: 3801987c1e20a697ea4638693aba1f2705074d64
 SHA512:
-  metadata.gz: 149c12f8221bee89fd75e8ae6ea344557df39c16a2e86c0aa4bf4c49872125a56b535907bf6e93e2dc8f58016c740b7b9e00ee65b5a30abec743aebc0ea3889e
-  data.tar.gz: 6e76250ea97bc1a16bba04c8323e911972d93edd814f4b35942fdea4de3c1a7f2d3f5cb8997709e2e006cee08aa8879435817c899476e0c25ff3378b13b1088d
+  metadata.gz: b1ecf7b7d40f706f3237ea39374c19c02b32784c13557abd134583d75964c964c99ec289d177e642667d49ea4cfc063fcbc83f1417689b3e184f84263657c233
+  data.tar.gz: 174b50aa05f1f9a73e84acbcda0d32284daa98095a7540f11352cd37ce9c6b8577fa3efe1abba120d2c54ea74d081ba0f5d24ac4befd6e2c16fb1fa482771c85

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## 0.0.4 (2014-05-04)
+
+CLI Features:
+
+* Add thor and reconstruct CLI
+* Simplify CLI by removing exec modes without interactive mode
+  * Now you can launch interaction cli without any exec options
+* Use option keyword `-n` and `-p` to specify request-num and limit-page
+* Change aliases
+* Cache last fetched reports
+* Add show command: it shows cached current reports
+

data/README.md

@@ -43,27 +43,38 @@ machine nicovideo.jp
 You can use following commands in interactive cli to fetch nicorepos.
 For example, if you want 20 video reports by searcing over 5 pages, the command will be,
 
-    > video 20 5
+    > video -n20 -p5
 
 Or you can also use aliases.
 
-    > v 20 5
+    > v -n20 -p5
 
-And each commad has default value so it is simply used like,
+`-n` and `-p` are specifing options.
+You can omit it as you like then each commad uses default value.
 
-    # it means `video 10 3`
     > v
+    # => `video -n10 -p3`
+    > v -n20
+    # => `video -n20 -p3`
+    > v -p5
+    # => `video -n20 -p5`
 
 **Commands**
 
-command  | alias | params                 | description
----------|-------|------------------------|-------------------------------------
-  all    | a     | request_num            | all reports
-  videos | v     | request_num limit_page | only videos
-  lives  | l     | request_num limit_page | only lives
-  open   | o     | report_num             | open the specified report url in the browser
-  login  |       |                        | re-login
-  exit   |       |                        | exit nicorepo
+command               | alias | description
+----------------------|-------|---------------------------------------------------------
+  all                 | a     | fetch all reports
+  videos              | v     | fetch only video reports
+  lives               | li    | fetch only live reports
+  show                | s     | show current reports
+  open REPORT-NUMBER  | o     | open the report url specified by number in your browser
+  help [COMMAND]      | h     | Describe available commands or one specific command
+  login               | lo    | re-login if your session is expired
+  exit                | e     | exit interactive prompt
+
+Some commands have specific options `-n, --request-num=N`, `-p, --limit-page=N`.
+Please check it out using `help [COMMAND]`.
+
 
 ### Configuration
 

data/bin/nicorepo

@@ -2,5 +2,5 @@
 
 require 'nicorepo'
 
-Nicorepo::Cli.new.run(ARGV)
+Nicorepo::Cli::Runner.run
 

data/lib/nicorepo/cli/cli.rb

@@ -1,151 +1,138 @@
+require 'thor'
+require 'netrc'
 require 'launchy'
 require 'readline'
-require 'netrc'
+require 'nicorepo/cli/config'
 
 class Nicorepo
-  class Cli
+  module Cli
+    class Runner
+      def self.run
+        loop do
+          args = Readline::readline("nicorepo > ", true).split
+          ret = Interactor.start(args)
+          break if ret == :exit
+        end
+      end
+    end
 
-    class ReportExistenceError < StandardError; end
-    class LoginAccountError < StandardError; end
+    class Interactor < Thor
+      class LoginAccountError < StandardError; end
+      class ReportExistenceError < StandardError; end
 
-    def initialize
-      @repo = Nicorepo.new
-      @reports = nil
-      @conf = Nicorepo::Cli::Config.new
-    end
+      class << self
+        attr_accessor :reports
+        attr_reader   :repo, :conf
 
-    def run(argv)
-      cmd, request_num, limit_page = parse(argv)
-      help if cmd == 'help'
+        def start(*)
+          @repo ||= Nicorepo.new
+          @conf ||= Nicorepo::Cli::Configuration.new
+          @reports ||= []
 
-      login
+          login unless logined?
 
-      reports = exec_command(cmd, request_num, limit_page)
-      if reports
-        disp reports
-      else
-        case cmd
-        when 'interactive'  then interactive_run
-        else help
+          super
         end
-      end
-    end
 
-    # returns true when exit
-    def interactive_run
-      loop do
-        argv = Readline::readline("nicorepo > ", true).split
-        cmd, request_num, limit_page = parse(argv)
-
-        reports = exec_command(cmd, request_num, limit_page)
-        if reports
-          @reports = reports
-          disp @reports
-        else
-          case cmd
-          when 'open'   then open_url(@reports, request_num)
-          when 'login'  then login
-          when 'exit'   then return true
-          else help_interactive; next
+        # replaces by a blank for help because Interactor dosen't require the basename
+        def basename
+          ''
+        end
+
+        def login
+          mail, pass = Netrc.read["nicovideo.jp"]
+          raise LoginAccountError, "machine nicovideo.jp is not defined in .netrc" if mail.nil? || pass.nil?
+          begin
+            @repo.login(mail, pass)
+          rescue
+            raise LoginAccountError, "invalid mail or pass: mail = #{mail}"
           end
+          @logined = true
         end
-      end
-    end
 
-    # options is now just for testing
-    def open_url(reports, request_num, options = {})
-      url = reports[request_num - 1].url
-      if url.nil?
-        puts "report existence error: please fetch reports"
-        raise ReportExistenceError
+        # TODO: Nicorepo側に持たせる
+        def logined?
+          @logined
+        end
       end
 
-      Launchy.open(url, options) do |exception|
-        puts "Attempted to open #{url} and failed because #{exception}"
-        raise exception
+      desc "login", "re-login if your session is expired"
+      def login
+        login
       end
 
-      return true
-    end
-
-    private
+      desc "all", "fetch all reports"
+      option :"request-num", type: :numeric, aliases: :n
+      def all
+        request_num = options[:"request-num"] || conf.request_num("all")
+        cache(repo.all(request_num))
+        show
+      end
 
-    def parse(argv)
-      cmd  = translate(argv.shift  || 'help')
-      request_num  = (argv.shift || @conf.request_num(cmd)).to_i
-      limit_page = (argv.shift || @conf.limit_page(cmd)).to_i
+      desc "videos", "fetch only video reports"
+      option :"request-num", type: :numeric, aliases: :n
+      option :"limit-page", type: :numeric, aliases: :p
+      def videos
+        request_num = options[:"request-num"] || conf.request_num("videos")
+        limit_page  = options[:"limit-page"]  || conf.limit_page("videos")
+        cache(repo.videos(request_num, limit_page))
+        show
+      end
 
-      return cmd, request_num, limit_page
-    end
+      desc "lives", "fetch only live reports"
+      option :"request-num", type: :numeric, aliases: :n
+      option :"limit-page", type: :numeric, aliases: :p
+      def lives
+        request_num = options[:"request-num"] || conf.request_num("lives")
+        limit_page  = options[:"limit-page"]  || conf.limit_page("lives")
+        cache(repo.lives(request_num, limit_page))
+        show
+      end
 
-    def login
-      mail, pass = Netrc.read["nicovideo.jp"]
-      raise LoginAccountError, "machine nicovideo.jp is not defined in .netrc" if mail.nil? || pass.nil?
+      desc "show", "show current reports"
+      def show
+        current_reports.each.with_index(1) do |report, i|
+          puts "[#{i}] #{report.body} on #{report.date.to_s}"
+          puts "    '#{report.title}' (#{report.url})"
+        end
+      end
 
-      begin
-        @repo.login(mail, pass)
-      rescue
-        raise LoginAccountError, "invalid mail or pass: mail = #{mail}"
+      desc "open REPORT-NUMBER", "open the report url specified by number in your browser"
+      def open(report_number)
+        open_numbered_link(report_number.to_i)
       end
-    end
 
-    # it returns
-    #   - reports if succeed to exec exepcted command
-    #   - nil     if unexpected command given
-    def exec_command(cmd, request_num, limit_page)
-      reports = nil
-
-      case cmd
-      when 'all'    then reports = @repo.all    request_num
-      when 'videos' then reports = @repo.videos request_num, limit_page
-      when 'lives'  then reports = @repo.lives  request_num, limit_page
-      else return nil
+      desc "exit", "exit interactive prompt"
+      def exit
+        :exit
       end
 
-      return reports
-    end
+      private
 
-    ALIAS = {"a" => "all", "v" => "videos", "l" => "lives",
-             "o" => "open", "i" => "interactive"}
-    def translate(cmd)
-      if ALIAS.has_key?(cmd)
-        ALIAS[cmd]
-      else
-        cmd
+      def repo
+        self.class.repo
       end
-    end
 
-    def help
-      puts '    usage: nicorepo command [params]'
-      puts '    command:'
-      help_commands
-      puts '        interactive, i - begin interactive mode'
-      exit 1
-    end
+      def conf
+        self.class.conf
+      end
 
-    def help_interactive
-      puts '    usage: command [params]'
-      puts '    command:'
-      help_commands
-      puts '        open, o [report_num] - open url of given report number'
-      puts '        login'
-      puts '        exit'
-    end
+      def current_reports
+        self.class.reports
+      end
 
-    def help_commands
-      puts <<-"EOS"
-        all, a    [request_num]
-        videos, v [request_num] [limit_page]
-        lives, l  [request_num] [limit_page]
-          *request_num - number of reports to fetch from nicovideo (default = 10)
-          *limit_page  - limit page to fetch reports(default = 3)
-      EOS
-    end
+      def cache(reports)
+        self.class.reports = reports
+      end
 
-    def disp(reports)
-      reports.each.with_index(1) do |report, i|
-        puts "[#{i}] #{report.body} on #{report.date.to_s}"
-        puts "    '#{report.title}' (#{report.url})"
+      def open_numbered_link(request_num)
+        url = current_reports[request_num - 1].url
+        raise ReportExistenceError, "report existence error: please fetch reports" if url.nil?
+
+        Launchy.open(url, options) do |exception|
+          puts "Attempted to open #{url} and failed because #{exception}"
+          raise exception
+        end
       end
     end
   end

data/lib/nicorepo/cli/config.rb

@@ -1,8 +1,8 @@
 require 'yaml'
 
 class Nicorepo
-  class Cli
-    class Config
+  module Cli
+    class Configuration
 
       class ReadError < StandardError; end
 

data/lib/nicorepo/reports.rb

@@ -1,13 +1,10 @@
 require 'nicorepo/report'
-require 'nicorepo/parser'
 require 'forwardable'
 
 class Nicorepo
   class Reports
     extend Forwardable
 
-    class ReportsAccessError < StandardError; end
-
     TOP_URL = 'http://www.nicovideo.jp/my/top'
 
     attr_reader :reports
@@ -22,7 +19,7 @@ class Nicorepo
       @reports = fetch_recursively(request_num, limit_page)
     end
 
-    def fetch_with_filtere(filter, request_num, limit_page)
+    def fetch_and_select_with(filter, request_num, limit_page)
       @reports = fetch_recursively(request_num, limit_page, filter)
     end
 
@@ -31,43 +28,29 @@ class Nicorepo
     def fetch_recursively(request_num, limit_page, filter = nil, url = TOP_URL)
       return [] unless limit_page > 0
 
-      # fetch current reports
+      # fetch current page reports
       page = @parser.parse_page(url)
-      begin
-        reports = page[:reports_attrs].map { |attrs| Report.new(attrs) }
-      rescue
-        raise ReportsAccessError
-      end
+      reports = page[:reports_attrs].map { |attrs| Report.new(attrs) }
       reports.select!{ |report| report.kind =~ /#{filter}/ } if filter
 
-      if reports.size > request_num then
-        return reports[0, request_num]
-      end
+      return reports[0, request_num] if reports.size >= request_num
 
       # recursively fetch next reports
-      if reports.size < request_num then
-        begin
-          next_reports = fetch_recursively(request_num - reports.size, limit_page - 1, filter, page[:next_url])
-        rescue
-          return reports
-        else
-          reports += next_reports unless next_reports.nil?
-        end
-      end
-
-      return reports
+      next_reports = fetch_recursively(request_num - reports.size, limit_page - 1, filter, page[:next_url])
+      reports += next_reports unless next_reports.nil?
+      reports
     end
   end
 
   class VideoReports < Reports
     def fetch(request_num, limit_page)
-      fetch_with_filtere('video-upload', request_num, limit_page)
+      fetch_and_select_with('video-upload', request_num, limit_page)
     end
   end
 
   class LiveReports < Reports
     def fetch(request_num, limit_page)
-      fetch_with_filtere('live', request_num, limit_page)
+      fetch_and_select_with('live', request_num, limit_page)
     end
   end
 end

data/lib/nicorepo/version.rb

@@ -1,3 +1,3 @@
 class Nicorepo
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/nicorepo.rb

@@ -1,5 +1,6 @@
 require 'mechanize'
 require 'nicorepo/reports'
+require 'nicorepo/parser'
 
 class Nicorepo
   class LoginError < StandardError; end
@@ -35,7 +36,6 @@ class Nicorepo
   end
 end
 
-require "nicorepo/version"
 require 'nicorepo/cli/cli'
-require 'nicorepo/cli/config'
+require "nicorepo/version"
 

data/nicorepo.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "mechanize", "~> 2.7"
   spec.add_dependency "launchy", "~> 2.4"
   spec.add_dependency "netrc", "~> 0.7"
+  spec.add_dependency "thor", "~> 0.19"
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "pry"

data/spec/cli/cli_config_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
-describe Nicorepo::Cli::Config do
-  let(:conf) { Nicorepo::Cli::Config.new }
+describe Nicorepo::Cli::Configuration do
+  let(:conf) { Nicorepo::Cli::Configuration.new }
 
   before do
-    Nicorepo::Cli::Config.any_instance.stub(:load_config).and_return(config_values)
+    Nicorepo::Cli::Configuration.any_instance.stub(:load_config).and_return(config_values)
   end
 
   describe "#request_num" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nicorepo
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - upinetree
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-29 00:00:00.000000000 Z
+date: 2014-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +133,7 @@ files:
 - ".gitignore"
 - ".nicorepo.yaml.sample"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md