lucadeal 0.2.16 → 0.2.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f17d75af6f101c60eced0ecfb770e39ac66b0f35725a6976f135216a0c75099
-  data.tar.gz: d3e60d51908e78ab72e177f29affc26864744afb584d1c5dadd507b18ff888f6
+  metadata.gz: 5f3d23a1f082ee44833db42f3cf4dbdecc0d078ea3ca6499d5cf77e6d235580a
+  data.tar.gz: c2ea468ea064bb865d0b481d9717a03f11afe212f0bfd3b58ac43722116a95e7
 SHA512:
-  metadata.gz: bd534c31a33405478cdeba88777481f5c17af6337cf743e2d16a8e5027209a65d1efb8329cf7f6e72318dfea8c3daa1965d9cf1e833ce93b85d24925c17638f6
-  data.tar.gz: f1d809de08ce94cf7da913c5bc733515f95bba596dc155596880cb4776837113c36f93ee4247c35fe34990f2a45fd758df1bddec3d2e587d182062cdb5893c60
+  metadata.gz: 545d6acb5b7837497c30d17a42c6a32611186f2e12f9821d116c9aa3ed9735dc1c8bc2c072d1439c9e21e1fd38d7398de770ffd9fd835352f4565f96a18a19ca
+  data.tar.gz: c8cf01067781332a241138ab9b253d282902a3838a19d2f9623d9eb29c6c4a3432e7d0e6818bc67a3e3b3e682e5ba3c4c5c128a90f93b3f91dcadca0285ea2f4

data/CHANGELOG.md

@@ -1,3 +1,35 @@
+## LucaDeal 0.2.23
+
+* implement `luca-deal invoices list --mail`: payment list via HTML mail
+
+## LucaDeal 0.2.22
+
+* Breaking change: export key 'value' -> 'amount'
+
+## LucaDeal 0.2.21
+
+* Implement `luca-deal fee` subcommands.
+* single invoice creation with contract id fragment.
+
+## LucaDeal 0.2.20
+
+* CLI provides `--nu` option. Add JSON output.
+* `luca-deal invoices list --html`, rendering HTML to stdout.
+
+## LucaDeal 0.2.19
+
+* CLI id completion on Customer delete, Contract create/delete
+* add `describe` to Customer / Contract
+
+## LucaDeal 0.2.18
+
+* Breaking change: restructure CLI in sub-sub command format.
+* Add 'x-customer', 'x-editor' on export to LucaBook
+
+## LucaDeal 0.2.17
+
+* `luca-deal export` export JSON for LucaBook
+
 ## LucaDeal 0.2.14
 
 * Introduce Product for selling items template.

data/README.md

@@ -22,7 +22,67 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You can create project skelton with `new` sub command.
+
+```
+$ luca-deal new Dir
+```
+
+Example assumes setup with bundler shim. `bundle exec` prefix may be needed in most cases.
+
+
+### Manage Contract
+
+Customer object can be created by `customer create` subcommand with name.
+
+```
+$ luca-deal customer create CustomerName
+Successfully generated Customer  5976652cc2d9c0ebf4a8646f7a28aa8d6bd2d606
+Edit customer detail.
+```
+
+Customer is filed under `data/customers` as YAML. Detail need to be editted.  
+Then, Contract object is created by `contract create` sub command with customer id.
+
+```
+$ luca-deal contract create 5976652cc2d9c0ebf4a8646f7a28aa8d6bd2d606
+uccessfully generated Contract  814c6fc9fffe5566fe8e7ef683b439b355d612dc
+Conditions are tentative. Edit contract detail.
+```
+
+Contract is filed under `data/contracts` as YAML. Detail need to be editted.
+
+
+### Issue invoice
+
+Monthly invoices are generated with `invoice create --monthly` sub command. Target month is optional. Without month, this month including today is the target.
+
+```
+$ luca-deal invoice create --monthly [yyyy m]
+```
+
+Or, any invoice can be created with contract ID. Contract ID is just unique fragment of uuid, listed with `luca-deal invoice create` with no args.
+
+```
+$ luca-deal invoice create 1d3 yyyy m
+```
+
+Invoice conditions are defined by contracts.
+
+
+### Send Invoice
+
+Invoice is implemented with HTML & ERB. Copy [default template](lib/luca_deal/templates/invoice.html.erb) to `templates/` in the data directory, and customize.  
+If you want to send invoices in PDF, you need to install `wkhtmltopdf command separately. Send mail command is as bellows:`
+
+```
+$ luca-deal invoice mail yyyy m
+```
+
+
+### Sales Fee
+
+You can also manage revenue share program with Fee object. Setup proper contract structure.
 
 
 ## Data Structure

data/exe/luca-deal

@@ -5,57 +5,247 @@ require 'date'
 require 'optparse'
 require 'luca_deal'
 
-def customer(args = nil, params = {})
-  case params['mode']
-  when 'list'
-    LucaDeal::Customer.new.list_name
-  when 'create'
-    if params['name']
-      id = LucaDeal::Customer.create(name: params['name'])
-      puts "Successfully generated Customer  #{id}" if id
-      puts 'Edit customer detail.' if id
-    else
-      puts 'requires customer\'s name. exit'
-      exit 1
+class LucaCmd
+  class Customer < LucaCmd
+    def self.create(args = nil, params = {})
+      if args
+        id = LucaDeal::Customer.create(name: args[0])
+        puts "Successfully generated Customer  #{id}" if id
+        puts 'Edit customer detail.' if id
+      else
+        puts 'requires customer\'s name. exit'
+        exit 1
+      end
+    end
+
+    def self.describe(args = nil, params = {})
+      if args.empty?
+        list = LucaDeal::Customer.id_completion('')
+        puts 'requires customer\'s id. exit'
+        list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+        exit 1
+      else
+        list = LucaDeal::Customer.id_completion(args[0])
+        case list.length
+        when 1
+          render(LucaDeal::Customer.new.describe(list.first), params)
+        else
+          puts 'found multiple contract id. exit'
+          list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+          exit 1
+        end
+      end
+    end
+
+    def self.delete(args = nil, params = {})
+      if args.empty?
+        list = LucaDeal::Customer.id_completion('')
+        puts 'requires customer\'s id. exit'
+        list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+        exit 1
+      else
+        list = LucaDeal::Customer.id_completion(args[0])
+        case list.length
+        when 1
+          id = LucaDeal::Customer.delete(list.first)
+        else
+          puts 'found multiple customer\'s id. exit'
+          list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+          exit 1
+        end
+      end
+    end
+
+    def self.list(args = nil, params = {})
+      render(LucaDeal::Customer.new.list_name, params)
     end
-  else
-    puts 'invalid option. --help for usage'
-    exit 1
   end
-end
 
-def contract(args = nil, params = {})
-  case params['mode']
-  when 'create'
-    if params['customer_id']
-      id = LucaDeal::Contract.new.generate!(params['customer_id'], params['category'])
-      puts "Successfully generated Contract  #{id}" if id
-      puts 'Conditions are tentative. Edit contract detail.' if id
-    else
-      puts 'requires customer\'s id. exit'
-      exit 1
+  class Contract < LucaCmd
+    def self.create(args = nil, params = {})
+      if args.empty?
+        list = LucaDeal::Customer.id_completion('')
+        puts 'requires customer\'s id. exit'
+        list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+        exit 1
+      else
+        list = LucaDeal::Customer.id_completion(args[0])
+        case list.length
+        when 1
+          id = LucaDeal::Contract.new.generate!(list.first, params['category'])
+          puts "Successfully generated Contract  #{id}" if id
+          puts 'Conditions are tentative. Edit contract detail.' if id
+        else
+          puts 'found multiple customer\'s id. exit'
+          list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+          exit 1
+        end
+      end
+    end
+
+    def self.describe(args = nil, params = {})
+      if args.empty?
+        list = LucaDeal::Contract.id_completion('', label: 'customer_name')
+        puts 'requires contract id. exit'
+        list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+        exit 1
+      else
+        list = LucaDeal::Contract.id_completion(args[0])
+        case list.length
+        when 1
+          render(LucaDeal::Contract.new.describe(list.first), params)
+        else
+          puts 'found multiple contract id. exit'
+          list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+          exit 1
+        end
+      end
+    end
+
+    def self.delete(args = nil, params = {})
+      if args.empty?
+        list = LucaDeal::Contract.id_completion('', label: 'customer_name')
+        puts 'requires contract id. exit'
+        list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+        exit 1
+      else
+        list = LucaDeal::Contract.id_completion(args[0])
+        case list.length
+        when 1
+          id = LucaDeal::Contract.delete(list.first)
+        else
+          puts 'found multiple contract id. exit'
+          list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+          exit 1
+        end
+      end
     end
-  else
   end
-end
 
-def invoice(args = nil, params = {})
-  date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
-  case params['mode']
-  when 'monthly'
-    LucaDeal::Invoice.new(date).monthly_invoice
-  when 'mail'
-    LucaDeal::Invoice.new(date).deliver_mail
-  when 'preview'
-    LucaDeal::Invoice.new(date).preview_mail
-  when 'stats'
-    if args.empty?
-      date = "#{Date.today.year}-#{Date.today.month}-1"
-      count = 3
-    end
-    LucaDeal::Invoice.new(date).stats(count || 1)
-  else
-    puts 'not implemented mode'
+  class Invoice < LucaCmd
+    def self.create(args = nil, params = {})
+      case params['mode']
+      when 'monthly'
+        date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
+        LucaDeal::Invoice.new(date).monthly_invoice
+      else
+        date = "#{args[1]}-#{args[2]}-#{args[3] || '1'}" if !args.empty?
+        list = LucaDeal::Contract.id_completion(args[0] || '', label: 'customer_name')
+        if args.length != 3
+          puts 'requires contract id & year month. exit'
+          list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+          exit 1
+        else
+          case list.length
+          when 1
+            id = LucaDeal::Invoice.new(date).single_invoice(list.first)
+          else
+            puts 'found multiple contract id. exit'
+            list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+            exit 1
+          end
+        end
+      end
+    end
+
+    def self.delete(args = nil, params = {})
+      if args
+        id = LucaDeal::Invoice.delete(args[0])
+      else
+        puts 'requires contract id. exit'
+        exit 1
+      end
+    end
+
+    def self.export(args = nil, _params = nil)
+      if args
+        args << 28 if args.length == 2 # specify safe last day
+        LucaDeal::Invoice.new(args.join('-')).export_json
+      else
+        LucaDeal::Invoice.new.export_json
+      end
+    end
+
+    def self.list(args = nil, params = {})
+      date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
+      if args.empty?
+        date = "#{Date.today.year}-#{Date.today.month}-1"
+        count = 3
+      end
+      if params[:html]
+        LucaDeal::Invoice.new(date).preview_stdout
+      elsif params[:mail]
+        LucaDeal::Invoice.new(date).stats_email
+      else
+        render(LucaDeal::Invoice.new(date).stats(count || 1), params)
+      end
+    end
+
+    def self.mail(args = nil, params = {})
+      date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
+      case params['mode']
+      when 'preview'
+        LucaDeal::Invoice.new(date).preview_mail
+      else
+        LucaDeal::Invoice.new(date).deliver_mail
+      end
+    end
+  end
+
+  class Fee < LucaCmd
+    def self.create(args = nil, params = {})
+      case params['mode']
+      when 'monthly'
+        date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
+        LucaDeal::Fee.new(date).monthly_fee
+      else
+        puts "not implemented yet"
+        exit 1
+      end
+    end
+
+    def self.delete(args = nil, params = {})
+      if args
+        id = LucaDeal::Fee.delete(args[0])
+      else
+        puts 'requires contract id. exit'
+        exit 1
+      end
+    end
+
+    def self.list(args = nil, params = {})
+      date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
+      if args.empty?
+        date = "#{Date.today.year}-#{Date.today.month}-1"
+        count = 3
+      end
+      if params[:html]
+        LucaDeal::Fee.new(date).preview_stdout
+      else
+        render(LucaDeal::Fee.new(date).stats(count || 1), params)
+      end
+    end
+
+    def self.mail(args = nil, params = {})
+      date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
+      case params['mode']
+      when 'preview'
+        LucaDeal::Fee.new(date).preview_mail
+      else
+        LucaDeal::Fee.new(date).deliver_mail
+      end
+    end
+  end
+
+  def self.render(dat, params)
+    case params[:output]
+    when 'json'
+      puts JSON.dump(dat)
+    when 'nu'
+      LucaSupport::View.nushell(YAML.dump(dat))
+    else
+      puts YAML.dump(dat)
+    end
   end
 end
 
@@ -65,54 +255,171 @@ end
 
 LucaRecord::Base.valid_project?
 cmd = ARGV.shift
+params = {}
 
 case cmd
-when 'customer'
-  params = {}
-  OptionParser.new do |opt|
-    opt.banner = 'Usage: luca-deal customer [options]'
-    opt.on('--list', 'list all customers') { |v| params['mode'] = 'list' }
-    opt.on('--create CustomerName', 'register new customer') do |v|
-      params['mode'] = 'create'
-      params['name'] = v
+when /customers?/
+  subcmd = ARGV.shift
+  case subcmd
+  when 'create'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal customers create CustomerName'
+      args = opt.parse(ARGV)
+      LucaCmd::Customer.create(args, params)
     end
-    args = opt.parse(ARGV)
-    customer(args, params)
+  when 'list'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal customers list [options]'
+      opt.on('--nu', 'show table in nushell') { |_v| params[:output] = 'nu' }
+      opt.on('-o', '--output VAL', 'output serialized data') { |v| params[:output] = v }
+      args = opt.parse(ARGV)
+      LucaCmd::Customer.list(args, params)
+    end
+  when 'describe'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal customers describe [options] customer_id'
+      opt.on('--nu', 'show table in nushell') { |_v| params[:output] = 'nu' }
+      opt.on('-o', '--output VAL', 'output serialized data') { |v| params[:output] = v }
+      args = opt.parse(ARGV)
+      LucaCmd::Customer.describe(args, params)
+    end
+  when 'delete'
+    LucaCmd::Customer.delete(ARGV)
+  else
+    puts 'Proper subcommand needed.'
+    puts
+    puts 'Usage: luca-deal customer[s] subcommands [--help|options]'
+    puts '  create'
+    puts '  list'
+    puts '  describe: show customer with contracts info'
+    puts '  delete'
+    exit 1
   end
-when 'contract'
-  params = {}
-  OptionParser.new do |opt|
-    opt.banner = 'Usage: luca-deal contract [options]'
-    opt.on('--create CustomerId', 'register new contract') do |v|
-      params['mode'] = 'create'
-      params['customer_id'] = v
+when /contracts?/
+  subcmd = ARGV.shift
+  case subcmd
+  when 'create'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal contracts create [options] CustomerId'
+      opt.on('--salesfee', 'create contract as sales fee definition') do |_v|
+        params['category'] = 'sales_fee'
+      end
+      args = opt.parse(ARGV)
+      LucaCmd::Contract.create(args, params)
     end
-    opt.on('--salesfee', 'create contract as sales fee definition') do |_v|
-      params['category'] = 'sales_fee'
+  when 'describe'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal contracts describe [options] customer_id'
+      opt.on('--nu', 'show table in nushell') { |_v| params[:output] = 'nu' }
+      opt.on('-o', '--output VAL', 'output serialized data') { |v| params[:output] = v }
+      args = opt.parse(ARGV)
+      LucaCmd::Contract.describe(args, params)
     end
-    args = opt.parse(ARGV)
-    contract(args, params)
+  when 'delete'
+    LucaCmd::Contract.delete(ARGV)
+  else
+    puts 'Proper subcommand needed.'
+    puts
+    puts 'Usage: luca-deal contract[s] subcommand [--help|options]'
+    puts '  create'
+    puts '  describe: show contract with puroducts or items info'
+    puts '  delete'
+    exit 1
   end
-when 'invoice'
-  params = {}
-  OptionParser.new do |opt|
-    opt.banner = 'Usage: luca-deal invoice [options] year month [date]'
-    opt.on('--monthly', 'generate monthly data') { |v| params['mode'] = 'monthly' }
-    opt.on('--mail', 'send to customers') { |v| params['mode'] = 'mail' }
-    opt.on('--preview', 'send to preview user') { |v| params['mode'] = 'preview' }
-    opt.on('--stats', 'list invoices') { |v| params['mode'] = 'stats' }
-    args = opt.parse(ARGV)
-    invoice(args, params)
+when 'export'
+  LucaCmd::Invoice.export(ARGV)
+when /invoices?/, 'i'
+  subcmd = ARGV.shift
+  case subcmd
+  when 'create'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal invoices create [options] --monthly|contract_id year month [date]'
+      opt.on('--monthly', 'generate monthly data') { |_v| params['mode'] = 'monthly' }
+      args = opt.parse(ARGV)
+      LucaCmd::Invoice.create(args, params)
+    end
+  when 'delete'
+    LucaCmd::Invoice.delete(ARGV)
+  when 'list'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal invoices list [options] year month [date]'
+      opt.on('--nu', 'show table in nushell') { |_v| params[:output] = 'nu' }
+      opt.on('-o', '--output VAL', 'output serialized data') { |v| params[:output] = v }
+      opt.on('--html', 'output html invoices') { |_v| params[:html] = 'monthly' }
+      opt.on('--mail', 'send payment list by email') { |_v| params[:mail] = true }
+      args = opt.parse(ARGV)
+      LucaCmd::Invoice.list(args, params)
+    end
+  when 'mail'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal invoices mail [options] year month [date]'
+      opt.on('--preview', 'send to preview user') { |_v| params['mode'] = 'preview' }
+      args = opt.parse(ARGV)
+      LucaCmd::Invoice.mail(args, params)
+    end
+  else
+    puts 'Proper subcommand needed.'
+    puts
+    puts 'Usage: luca-deal invoices subcommand [--help|options]'
+    puts '  create'
+    puts '  delete'
+    puts '  list'
+    puts '  mail: send mail with invoice'
+    exit 1
   end
 when 'new'
   params = {}
   OptionParser.new do |opt|
+    opt.banner = 'Usage: luca-deal new DIR'
     args = opt.parse(ARGV)
     new_pj(args, params)
   end
+when /fee/
+  subcmd = ARGV.shift
+  case subcmd
+  when 'create'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal fee create [options] year month [date]'
+      opt.on('--monthly', 'generate monthly data') { |_v| params['mode'] = 'monthly' }
+      args = opt.parse(ARGV)
+      LucaCmd::Fee.create(args, params)
+    end
+  when 'delete'
+    LucaCmd::Fee.delete(ARGV)
+  when 'list'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal fee list [options] year month [date]'
+      opt.on('--nu', 'show table in nushell') { |_v| params[:output] = 'nu' }
+      opt.on('-o', '--output VAL', 'output serialized data') { |v| params[:output] = v }
+      opt.on('--html', 'output html invoices') { |_v| params[:html] = 'monthly' }
+      args = opt.parse(ARGV)
+      LucaCmd::Fee.list(args, params)
+    end
+  when 'mail'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal fee mail [options] year month [date]'
+      opt.on('--preview', 'send to preview user') { |_v| params['mode'] = 'preview' }
+      args = opt.parse(ARGV)
+      LucaCmd::Fee.mail(args, params)
+    end
+  else
+    puts 'Proper subcommand needed.'
+    puts
+    puts 'Usage: luca-deal fee subcommand [--help|options]'
+    puts '  create'
+    puts '  delete'
+    puts '  list'
+    puts '  mail: send mail with report'
+    exit 1
+  end
 else
-  puts 'Usage: luca-deal sub-command [--help|options]'
-  puts '        customer'
-  puts '        contract'
-  puts '        invoice'
+  puts 'Proper subcommand needed.'
+  puts
+  puts 'Usage: luca-deal subcommand [options]'
+  puts '        customers'
+  puts '        contracts'
+  puts '        invoices'
+  puts '        new: initialize project dir'
+  puts '        export: puts invoice data for LucaBook import'
+  exit 1
 end