prt 0.3.0

data/spec/parrot/commands/new_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Parrot::Commands do
+  let(:config) { Parrot::Config.new(Dir.pwd, TestLogger) }
+
+  context 'NewCommand' do
+    it 'has a run method' do
+      expect(Parrot::Commands::NewCommand.new(%w[foo], config)).to respond_to(:run)
+    end
+
+    context 'Setup a blog' do
+      let(:app_name) { 'my-test-blog' }
+
+      after(:each) do
+        FileUtils.rm_rf(app_name)
+      end
+
+      it 'Verify all files from skeleton template is copied correctly' do
+        Parrot::Commands::NewCommand.new([app_name], config).run
+
+        expect(Dir.exist?(app_name)).to be true
+
+        file_list = [
+          "#{app_name}/config.yaml",
+          "#{app_name}/css/app.scss",
+          "#{app_name}/images/favicon.ico",
+          "#{app_name}/images/favicon.svg",
+          "#{app_name}/images/apple-touch-icon.png",
+          "#{app_name}/images/parrot.jpeg",
+          "#{app_name}/javascripts/app.js",
+          "#{app_name}/public/.keep",
+          "#{app_name}/views/404.md",
+          "#{app_name}/views/about.md",
+          "#{app_name}/views/layout.html.erb",
+          "#{app_name}/views/posts/about_parrot.md",
+          "#{app_name}/views/posts/sample.md"
+        ]
+
+        expect(file_list.all? { |file| File.exist?(file) }).to be true
+      end
+    end
+  end
+end

data/spec/parrot/commands/post_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe Parrot::Commands do
+  let(:config) { Parrot::Config.new(File.expand_path('blog'), TestLogger) }
+
+  before do
+    FileUtils.rm_rf('blog')
+    Parrot::Commands::NewCommand.new(%w[blog], config).run
+  end
+
+  after do
+    FileUtils.rm_rf('blog')
+  end
+
+  context 'PostCommand' do
+    it 'has a run method' do
+      expect(Parrot::Commands::PostCommand.new(%w[--title hello], config)).to respond_to(:run)
+    end
+
+    it 'shows the usage example when called without a title' do
+      expect { Parrot::Commands::PostCommand.new([], config) }
+        .to raise_error(ArgumentError, /parrot post --title "My new post"/)
+    end
+
+    it 'shows the usage example when --title is given no value' do
+      expect { Parrot::Commands::PostCommand.new(%w[--title], config) }
+        .to raise_error(ArgumentError, /parrot post --title "My new post"/)
+    end
+
+    it 'shows the usage example when the title has no usable characters' do
+      expect { Parrot::Commands::PostCommand.new(%w[--title !!!], config).run }
+        .to raise_error(ArgumentError, /parrot post --title "My new post"/)
+    end
+
+    it 'accepts the title from --title, including trailing words' do
+      Parrot::Commands::PostCommand.new(['--title', 'My', 'First', 'Post!'], config).run
+
+      post_path = 'blog/views/posts/my-first-post.md'
+      expect(File.exist?(post_path)).to be true
+
+      body = File.read(post_path)
+      expect(body).to include("<!--\ntitle: My First Post!\ndate: #{Date.today.strftime('%d/%m/%Y')}\nlang: en\ncategory:\n-->")
+      expect(body).to include('# {post_title}')
+      # the build adds the date under the title itself now
+      expect(body).not_to include('{post_date}')
+    end
+
+    it 'also accepts the title as a plain quoted argument' do
+      Parrot::Commands::PostCommand.new(['A plain title'], config).run
+      expect(File.exist?('blog/views/posts/a-plain-title.md')).to be true
+    end
+
+    %w[About 404 Index index2 ABOUT Now post Posts note NOTES Category Categories].each do |title|
+      it "refuses the reserved title #{title.inspect}" do
+        expect { Parrot::Commands::PostCommand.new(['--title', title], config).run }
+          .to raise_error(ArgumentError, /is a reserved post name/)
+        expect(Dir['blog/views/posts/*.md'].map { |path| File.basename(path) })
+          .to contain_exactly('about_parrot.md', 'sample.md')
+      end
+    end
+
+    it 'allows titles that only contain a reserved word' do
+      Parrot::Commands::PostCommand.new(['--title', 'About me'], config).run
+      Parrot::Commands::PostCommand.new(['--title', 'Index 2'], config).run
+      Parrot::Commands::PostCommand.new(['--title', 'Notes on Ruby'], config).run
+      Parrot::Commands::PostCommand.new(['--title', 'Nowhere'], config).run
+      Parrot::Commands::PostCommand.new(['--title', 'Category theory'], config).run
+      expect(File.exist?('blog/views/posts/about-me.md')).to be true
+      expect(File.exist?('blog/views/posts/index-2.md')).to be true
+      expect(File.exist?('blog/views/posts/notes-on-ruby.md')).to be true
+      expect(File.exist?('blog/views/posts/nowhere.md')).to be true
+      expect(File.exist?('blog/views/posts/category-theory.md')).to be true
+    end
+
+    it 'refuses to overwrite an existing post' do
+      Parrot::Commands::PostCommand.new(%w[--title Dup], config).run
+      expect { Parrot::Commands::PostCommand.new(%w[--title Dup], config).run }.to raise_error(/already exists/)
+    end
+  end
+end

data/spec/parrot/commands/serve_spec.rb

@@ -0,0 +1,66 @@
+require 'net/http'
+
+describe Parrot::Commands do
+  let(:config) { Parrot::Config.new(Dir.pwd, TestLogger) }
+
+  before do
+    # create a new application
+    Parrot::Commands::NewCommand.new(%w[blog], config).run
+  end
+
+  after do
+    # cleanup
+    FileUtils.rm_rf('blog')
+  end
+
+  context 'ServeCommand' do
+    it 'has a run method' do
+      expect(Parrot::Commands::ServeCommand.new([], config)).to respond_to(:run)
+    end
+
+    it 'run a webserver at port 8000 serving files' do
+      # Parrot::Commands::ServeCommand.new([]).run
+    end
+  end
+
+  context 'ServeCommand::FileHandler' do
+    let(:document_root) { File.expand_path('blog/public') }
+
+    before do
+      FileUtils.mkdir_p(document_root)
+      File.write(File.join(document_root, 'index.html'), 'home page')
+      @server = WEBrick::HTTPServer.new(Port: 0, Logger: WEBrick::Log.new(File::NULL), AccessLog: [])
+      @server.mount('/', Parrot::Commands::ServeCommand::FileHandler, document_root)
+      @thread = Thread.new { @server.start }
+      @port = @server.config[:Port]
+    end
+
+    after do
+      @server.shutdown
+      @thread.join
+    end
+
+    def get(path)
+      Net::HTTP.get_response(URI("http://127.0.0.1:#{@port}#{path}"))
+    end
+
+    it 'serves existing files' do
+      response = get('/index.html')
+      expect(response.code).to eq('200')
+      expect(response.body).to eq('home page')
+    end
+
+    it 'answers a missing path with the built 404.html and a 404 status' do
+      File.write(File.join(document_root, '404.html'), 'custom not found')
+      response = get('/missing')
+      expect(response.code).to eq('404')
+      expect(response.body).to eq('custom not found')
+    end
+
+    it "falls back to WEBrick's error page when no 404.html was built" do
+      response = get('/missing')
+      expect(response.code).to eq('404')
+      expect(response.body).to include('Not Found')
+    end
+  end
+end

data/spec/parrot/logger_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Parrot::ParrotLoggerBuilder do
+  let(:parrot_logger) { Parrot::ParrotLoggerBuilder.new(false) }
+
+  it 'is an instance of Logger' do
+    expect(parrot_logger.logger).to be_an_instance_of(Logger)
+  end
+
+  it 'has a log method' do
+    expect(parrot_logger).to respond_to(:log)
+  end
+
+  it 'logs a message to stdout by default' do
+    expect(parrot_logger).to receive(:log).with('Hello parrot')
+    parrot_logger.log('Hello parrot')
+  end
+
+  it 'sets the instance variable @logger' do
+    expect(parrot_logger.instance_variable_defined?(:@logger)).to be true
+  end
+
+  it 'sets the instance variable @device' do
+    expect(parrot_logger.instance_variable_defined?(:@device)).to be true
+  end
+
+  it 'sets the log device as STDOUT by default' do
+    allow(Parrot::Helpers).to receive(:testing?).and_return(false)
+    expect(parrot_logger.device).to eq($stdout)
+  end
+
+  it 'In test mode the device will be set to a test log file' do
+    expect(File.basename(parrot_logger.device.path)).to eq('parrot.test.log')
+  end
+
+  it 'sets the log device as a file if the quiet mode is turned on' do
+    expect(Parrot::ParrotLoggerBuilder.new(true).device).to be_a File
+  end
+end

data/spec/parrot/metadata_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'Metadata' do
+  it 'should have the right version string' do
+    expect(Parrot::VERSION).to eq '0.3.0'
+  end
+
+  it 'should have the HOMEPAGE set' do
+    expect(Parrot::HOMEPAGE).not_to be_empty
+  end
+end

data/spec/parrot/runner_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Parrot::Runner do
+  let(:config) { Parrot::Config.new(Dir.pwd, TestLogger) }
+
+  context 'Runner class' do
+    it 'should raise error if no application name provided for the new sub command' do
+      expect { Parrot::Runner.new('new', [], config) }.to raise_error(ArgumentError)
+    end
+
+    it 'should create a NewCommand object' do
+      runner = Parrot::Runner.new('new', %w[foo], config)
+      expect(runner.command).to be_an_instance_of(Parrot::Commands::NewCommand)
+    end
+
+    it 'should create a BuildCommand object' do
+      expect(Parrot::Runner.new('build', %w[foo], config).command).to be_an_instance_of(Parrot::Commands::BuildCommand)
+    end
+
+    it 'should create a ServeCommand object' do
+      expect(Parrot::Runner.new('serve', %w[foo], config).command).to be_an_instance_of(Parrot::Commands::ServeCommand)
+    end
+
+    it 'should raise error if the command is invalid' do
+      expect { Parrot::Runner.new('foo', config) }.to raise_error(NameError)
+    end
+  end
+end

data/spec/parrot_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Parrot do
+  context 'with option -v' do
+    let(:args) { %w[-v] }
+
+    it 'displays version info' do
+      expect { Parrot::Parrot.new(args).run }.to output("Parrot: #{Parrot::VERSION}\n").to_stdout
+    end
+  end
+
+  context 'with option -h' do
+    let(:args) { %w[-h] }
+    it 'displays help message' do
+      expect { Parrot::Parrot.new(args).run }.to output(/Sub Commands:/).to_stdout
+    end
+  end
+
+  context 'in quiet mode' do
+    it 'will be quiet by default while testing' do
+      parrot = Parrot::Parrot.new
+      expect(parrot).to be_quiet
+    end
+
+    it 'will be be quiet on quiet option' do
+      args = %w[-q]
+      parrot = Parrot::Parrot.new(args)
+      expect(parrot).to be_quiet
+    end
+  end
+
+  context 'sub commands' do
+    it 'has the following commands' do
+      expect(Parrot::Parrot::SUB_COMMANDS).to eq(Parrot::SUB_COMMANDS_DOC.keys.map(&:to_s))
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'pry'
+require 'debug'
+require_relative '../lib/parrot'
+
+ENV['PARROT_TESTING'] = 'true'
+
+TestLogger = Parrot::ParrotLoggerBuilder.new(false).logger

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: prt
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Deepak Kumar
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown-parser-gfm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: observer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sassc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: watchr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A static blogging tool written in ruby, posts are in markdown format
+email:
+- deepakkumarnd@gmail.com
+executables:
+- parrot
+extensions: []
+extra_rdoc_files: []
+files:
+- ".githooks/pre-commit"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- CLAUDE.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- exe/parrot
+- lib/helpers.rb
+- lib/parrot.rb
+- lib/parrot/commands/build.rb
+- lib/parrot/commands/new.rb
+- lib/parrot/commands/post.rb
+- lib/parrot/commands/serve.rb
+- lib/parrot/constants.rb
+- lib/parrot/file_cache.rb
+- lib/parrot/logger.rb
+- lib/parrot/metadata.rb
+- lib/parrot/runner.rb
+- lib/parrot/template_handler.rb
+- parrot.gemspec
+- skel/.gitignore
+- skel/config.yaml
+- skel/css/app.scss
+- skel/images/.keep
+- skel/images/apple-touch-icon.png
+- skel/images/favicon.ico
+- skel/images/favicon.svg
+- skel/images/parrot.jpeg
+- skel/javascripts/app.js
+- skel/public/.keep
+- skel/views/404.md
+- skel/views/about.md
+- skel/views/layout.html.erb
+- skel/views/posts/about_parrot.md
+- skel/views/posts/sample.md
+- spec/parrot/commands/build_spec.rb
+- spec/parrot/commands/new_spec.rb
+- spec/parrot/commands/post_spec.rb
+- spec/parrot/commands/serve_spec.rb
+- spec/parrot/logger_spec.rb
+- spec/parrot/metadata_spec.rb
+- spec/parrot/runner_spec.rb
+- spec/parrot_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/deepakkumarnd/parrot
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 'Refer to readme at README.md to know how to get started with
+  Parrot
+
+  '
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: A static markdown blog builder written in ruby for minimalist bloggers
+test_files: []