scriptorium 0.0.3 → 0.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.lt3 +324 -0
- data/README.md +3155 -1
- data/assets/.DS_Store +0 -0
- data/assets/README.md +44 -0
- data/assets/icons/social/reddit.png +0 -0
- data/assets/icons/social/x-logo.png +0 -0
- data/assets/icons/ui/.DS_Store +0 -0
- data/assets/icons/ui/back.png +0 -0
- data/assets/icons/ui/copy.png +0 -0
- data/assets/icons/ui/down.png +0 -0
- data/assets/icons/ui/end.png +0 -0
- data/assets/icons/ui/exit.png +0 -0
- data/assets/icons/ui/foo +10 -0
- data/assets/icons/ui/home.png +0 -0
- data/assets/icons/ui/left.png +0 -0
- data/assets/icons/ui/next.png +0 -0
- data/assets/icons/ui/right.png +0 -0
- data/assets/icons/ui/start.png +0 -0
- data/assets/icons/ui/up.png +0 -0
- data/assets/imagenotfound.jpg +0 -0
- data/assets/samples/placeholder.svg +9 -0
- data/assets/themes/standard/favicon.svg +6 -0
- data/bin/sblog +84 -5
- data/bin/scriptorium +1 -0
- data/doc/README.txt +6 -0
- data/doc/anti-amnesia/20250727-054000-scriptorium-overview.md +94 -0
- data/doc/anti-amnesia/20250727-123000-anti-amnesia-conventions.md +2 -0
- data/doc/anti-amnesia/20250727-172600-cursor-rbenv-ruby-version-mystery.md +45 -0
- data/doc/anti-amnesia/20250727-172900-ai-cognitive-assessment-capabilities.md +40 -0
- data/doc/anti-amnesia/20250728-124243-aaa-syntax-clarification.md +46 -0
- data/doc/anti-amnesia/20250729-210000-reddit-autopost-integration-complete.md +158 -0
- data/doc/anti-amnesia/20250804-190500-cognitive-loop-bug.md +35 -0
- data/doc/anti-amnesia/20250804-190700-anti-amnesia-timestamping-fix.md +27 -0
- data/doc/anti-amnesia/20250807-213025.md +116 -0
- data/doc/anti-amnesia/20250901-211714-codemirror-integration-and-web-tests.md +172 -0
- data/doc/anti-amnesia/20250902-002402-backup-restore-system.md +126 -0
- data/doc/anti-amnesia/20250907-203339-backup-metadata-implementation.md +66 -0
- data/doc/banner_svg_config.md +114 -0
- data/doc/contrib.lt3 +8 -0
- data/doc/dependencies.md +281 -0
- data/doc/hacker.lt3 +5 -0
- data/doc/imported/0001-elixir-conf-2014/metadata.txt +7 -0
- data/doc/imported/0001-elixir-conf-2014/post.html +37 -0
- data/doc/imported/0001-elixir-conf-2014/source.lt3 +22 -0
- data/doc/imported/0002-programmers-and-word-processing/metadata.txt +7 -0
- data/doc/imported/0002-programmers-and-word-processing/post.html +192 -0
- data/doc/imported/0002-programmers-and-word-processing/source.lt3 +146 -0
- data/doc/imported/0003-how-to-turn-your-brain-sideways/metadata.txt +7 -0
- data/doc/imported/0003-how-to-turn-your-brain-sideways/post.html +60 -0
- data/doc/imported/0003-how-to-turn-your-brain-sideways/source.lt3 +40 -0
- data/doc/imported/0004-upcoming-lone-star-ruby-conference/metadata.txt +7 -0
- data/doc/imported/0004-upcoming-lone-star-ruby-conference/post.html +42 -0
- data/doc/imported/0004-upcoming-lone-star-ruby-conference/source.lt3 +24 -0
- data/doc/imported/0005-elixir-conf-2015-announced/metadata.txt +7 -0
- data/doc/imported/0005-elixir-conf-2015-announced/post.html +30 -0
- data/doc/imported/0005-elixir-conf-2015-announced/source.lt3 +16 -0
- data/doc/imported/0006-ruby-for-dinosaurs/metadata.txt +7 -0
- data/doc/imported/0006-ruby-for-dinosaurs/post.html +43 -0
- data/doc/imported/0006-ruby-for-dinosaurs/source.lt3 +27 -0
- data/doc/imported/0007-phoenix-isnt-rails/metadata.txt +7 -0
- data/doc/imported/0007-phoenix-isnt-rails/post.html +116 -0
- data/doc/imported/0007-phoenix-isnt-rails/source.lt3 +87 -0
- data/doc/imported/0008-concerning-the-term-monkeypatching/metadata.txt +7 -0
- data/doc/imported/0008-concerning-the-term-monkeypatching/post.html +129 -0
- data/doc/imported/0008-concerning-the-term-monkeypatching/source.lt3 +92 -0
- data/doc/imported/0009-announcement-coming-soon/metadata.txt +7 -0
- data/doc/imported/0009-announcement-coming-soon/post.html +33 -0
- data/doc/imported/0009-announcement-coming-soon/source.lt3 +19 -0
- data/doc/imported/0010-immutable-data-ditching-the-wax-tablet/metadata.txt +7 -0
- data/doc/imported/0010-immutable-data-ditching-the-wax-tablet/post.html +175 -0
- data/doc/imported/0010-immutable-data-ditching-the-wax-tablet/source.lt3 +139 -0
- data/doc/imported/0011-computer-science-as-a-lost-art/metadata.txt +7 -0
- data/doc/imported/0011-computer-science-as-a-lost-art/post.html +139 -0
- data/doc/imported/0011-computer-science-as-a-lost-art/source.lt3 +104 -0
- data/doc/imported/0012-ruby-day-in-turin-italy/metadata.txt +7 -0
- data/doc/imported/0012-ruby-day-in-turin-italy/post.html +42 -0
- data/doc/imported/0012-ruby-day-in-turin-italy/source.lt3 +24 -0
- data/doc/imported/0013-rubyday-was-a-success/metadata.txt +7 -0
- data/doc/imported/0013-rubyday-was-a-success/post.html +44 -0
- data/doc/imported/0013-rubyday-was-a-success/source.lt3 +27 -0
- data/doc/imported/0014-working-on-the-blogging-software/metadata.txt +7 -0
- data/doc/imported/0014-working-on-the-blogging-software/post.html +63 -0
- data/doc/imported/0014-working-on-the-blogging-software/source.lt3 +41 -0
- data/doc/imported/0015-ok-its-not-really-a-lost-art/metadata.txt +7 -0
- data/doc/imported/0015-ok-its-not-really-a-lost-art/post.html +172 -0
- data/doc/imported/0015-ok-its-not-really-a-lost-art/source.lt3 +134 -0
- data/doc/imported/0016-an-in-operator-for-ruby/metadata.txt +7 -0
- data/doc/imported/0016-an-in-operator-for-ruby/post.html +155 -0
- data/doc/imported/0016-an-in-operator-for-ruby/source.lt3 +106 -0
- data/doc/imported/0017-the-forgotten-mathematician/metadata.txt +7 -0
- data/doc/imported/0017-the-forgotten-mathematician/post.html +161 -0
- data/doc/imported/0017-the-forgotten-mathematician/source.lt3 +119 -0
- data/doc/imported/0018-ruby-puns/metadata.txt +7 -0
- data/doc/imported/0018-ruby-puns/post.html +46 -0
- data/doc/imported/0018-ruby-puns/source.lt3 +28 -0
- data/doc/imported/0019-custom-exceptions-via-metaprogramming/metadata.txt +7 -0
- data/doc/imported/0019-custom-exceptions-via-metaprogramming/post.html +138 -0
- data/doc/imported/0019-custom-exceptions-via-metaprogramming/source.lt3 +101 -0
- data/doc/imported/0020-fffff/metadata.txt +7 -0
- data/doc/imported/0020-fffff/post.html +24 -0
- data/doc/imported/0020-fffff/source.lt3 +12 -0
- data/doc/imported/0021-trying-ror-yet-again/metadata.txt +7 -0
- data/doc/imported/0021-trying-ror-yet-again/post.html +26 -0
- data/doc/imported/0021-trying-ror-yet-again/source.lt3 +12 -0
- data/doc/imported/0023-doctor-sleep/metadata.txt +7 -0
- data/doc/imported/0023-doctor-sleep/post.html +63 -0
- data/doc/imported/0023-doctor-sleep/source.lt3 +44 -0
- data/doc/imported/0024-just-a-test/metadata.txt +7 -0
- data/doc/imported/0024-just-a-test/post.html +24 -0
- data/doc/imported/0024-just-a-test/source.lt3 +12 -0
- data/doc/imported/import_summary.txt +98 -0
- data/doc/livetext-informal-spec.txt +65 -0
- data/doc/myuserdoc/ch-0.lt3 +31 -0
- data/doc/myuserdoc/ch-1.lt3 +37 -0
- data/doc/myuserdoc/ch-10.lt3 +22 -0
- data/doc/myuserdoc/ch-2.lt3 +37 -0
- data/doc/myuserdoc/ch-3.lt3 +19 -0
- data/doc/myuserdoc/ch-4.lt3 +43 -0
- data/doc/myuserdoc/ch-5.lt3 +22 -0
- data/doc/myuserdoc/ch-6.lt3 +19 -0
- data/doc/myuserdoc/ch-7.lt3 +16 -0
- data/doc/myuserdoc/ch-8.lt3 +13 -0
- data/doc/myuserdoc/ch-9.lt3 +19 -0
- data/doc/myuserdoc/tweak.rb +18 -0
- data/doc/myuserdoc/userdoc-toc.txt +88 -0
- data/doc/old-posts/0001-elixir-conf-2014.lt3 +24 -0
- data/doc/old-posts/0002-programmers-and-word-processing.lt3 +150 -0
- data/doc/old-posts/0003-how-to-turn-your-brain-sideways.lt3 +43 -0
- data/doc/old-posts/0004-upcoming-lone-star-ruby-conference.lt3 +26 -0
- data/doc/old-posts/0005-elixir-conf-2015-announced.lt3 +17 -0
- data/doc/old-posts/0006-ruby-for-dinosaurs.lt3 +30 -0
- data/doc/old-posts/0007-phoenix-isnt-rails.lt3 +90 -0
- data/doc/old-posts/0008-concerning-the-term-monkeypatching.lt3 +105 -0
- data/doc/old-posts/0009-announcement-coming-soon.lt3 +20 -0
- data/doc/old-posts/0010-immutable-data-ditching-the-wax-tablet.lt3 +142 -0
- data/doc/old-posts/0011-computer-science-as-a-lost-art.lt3 +117 -0
- data/doc/old-posts/0012-ruby-day-in-turin-italy.lt3 +26 -0
- data/doc/old-posts/0013-rubyday-was-a-success.lt3 +28 -0
- data/doc/old-posts/0014-working-on-the-blogging-software.lt3 +42 -0
- data/doc/old-posts/0015-ok-its-not-really-a-lost-art.lt3 +137 -0
- data/doc/old-posts/0016-an-in-operator-for-ruby.lt3 +142 -0
- data/doc/old-posts/0017-the-forgotten-mathematician.lt3 +129 -0
- data/doc/old-posts/0018-ruby-puns.lt3 +31 -0
- data/doc/old-posts/0019-custom-exceptions-via-metaprogramming.lt3 +116 -0
- data/doc/old-posts/0021-trying-ror-yet-again.lt3 +35 -0
- data/doc/old-posts/0023-doctor-sleep.lt3 +43 -0
- data/doc/old-posts/0024-just-a-test.lt3 +12 -0
- data/doc/old-posts/0025-trying-another-post.lt3 +12 -0
- data/doc/old-repo +1 -0
- data/doc/reddit_credentials_template.json +8 -0
- data/doc/reddit_integration.md +207 -0
- data/doc/user.lt3 +35 -0
- data/doc/user_guide_section_1.md +137 -0
- data/doc/user_guide_section_10.md +515 -0
- data/doc/user_guide_section_11.md +708 -0
- data/doc/user_guide_section_2.md +233 -0
- data/doc/user_guide_section_3.md +5 -0
- data/doc/user_guide_section_4.md +221 -0
- data/doc/user_guide_section_5.md +243 -0
- data/doc/user_guide_section_6.md +147 -0
- data/doc/user_guide_section_7.md +311 -0
- data/doc/user_guide_section_8.md +224 -0
- data/doc/user_guide_section_9.md +375 -0
- data/lib/rouge/lexers/livetext.rb +74 -0
- data/lib/scriptorium/api.rb +2373 -0
- data/lib/scriptorium/banner_svg.rb +729 -0
- data/lib/scriptorium/contract.rb +34 -0
- data/lib/scriptorium/exceptions.rb +201 -1
- data/lib/scriptorium/helpers.rb +675 -0
- data/lib/scriptorium/post.rb +259 -0
- data/lib/scriptorium/reddit.rb +83 -0
- data/lib/scriptorium/repo.rb +938 -0
- data/lib/scriptorium/standard_files.rb +149 -0
- data/lib/scriptorium/support/bootstrap/css.txt +5 -0
- data/lib/scriptorium/support/bootstrap/js.txt +4 -0
- data/lib/scriptorium/support/common_js/clipboard.js +35 -0
- data/lib/scriptorium/support/common_js/content-loader.js +187 -0
- data/lib/scriptorium/support/common_js/navigation.js +52 -0
- data/lib/scriptorium/support/common_js/syntax-highlighting.js +27 -0
- data/lib/scriptorium/support/config/reddit.txt +10 -0
- data/lib/scriptorium/support/config/reddit_template.txt +17 -0
- data/lib/scriptorium/support/config/social.txt +8 -0
- data/lib/scriptorium/support/highlight/css.txt +2 -0
- data/lib/scriptorium/support/highlight/custom.css +119 -0
- data/lib/scriptorium/support/highlight/js.txt +1 -0
- data/lib/scriptorium/support/post_index/config.txt +15 -0
- data/lib/scriptorium/support/post_index/style.css +55 -0
- data/lib/scriptorium/support/templates/index_entry.lt3 +16 -0
- data/lib/scriptorium/support/templates/initial_post.lt3 +12 -0
- data/lib/scriptorium/support/templates/layout.txt +5 -0
- data/lib/scriptorium/support/templates/post.lt3 +104 -0
- data/lib/scriptorium/support/theme/footer.lt3 +2 -0
- data/lib/scriptorium/support/theme/header.lt3 +4 -0
- data/lib/scriptorium/support/theme/left.lt3 +3 -0
- data/lib/scriptorium/support/theme/main.lt3 +5 -0
- data/lib/scriptorium/support/theme/right.lt3 +3 -0
- data/lib/scriptorium/theme.rb +192 -0
- data/lib/scriptorium/version.rb +1 -1
- data/lib/scriptorium/view.rb +1021 -0
- data/lib/scriptorium/widgets/featured_posts.rb +149 -0
- data/lib/scriptorium/widgets/links.rb +112 -0
- data/lib/scriptorium/widgets/pages.rb +133 -0
- data/lib/scriptorium/widgets/widget.rb +133 -0
- data/lib/scriptorium.rb +38 -34
- data/lib/skeleton.rb +10 -1
- data/scriptorium.gemspec +17 -5
- data/test/README.md +69 -0
- data/test/WEB_INTEGRATION_README.md +196 -0
- data/test/all +83 -0
- data/test/api_demo.rb +99 -0
- data/test/assets/imagenotfound.jpg +0 -0
- data/test/assets/images/.DS_Store +0 -0
- data/test/assets/images/README.md +27 -0
- data/test/assets/images/odd_aspect.png +0 -0
- data/test/assets/images/perfect.png +0 -0
- data/test/assets/images/small.png +0 -0
- data/test/assets/images/tall.png +0 -0
- data/test/assets/images/very_tall.png +0 -0
- data/test/assets/images/very_wide.png +0 -0
- data/test/assets/images/wide.png +0 -0
- data/test/assets/testbanner.jpg +0 -0
- data/test/banner_svg/simple_helpers.rb +13 -0
- data/test/banner_svg/unit.rb +1000 -0
- data/test/config/deployment.txt +5 -0
- data/test/ed_test.rb +204 -0
- data/test/integration/cursor_banner_combinations.rb +193 -0
- data/test/integration/cursor_banner_features.rb +374 -0
- data/test/integration/integration_test.rb +326 -0
- data/test/integration/preview_flow_test.rb +94 -0
- data/test/livetext_plugin_test.rb +500 -0
- data/test/manual/asset_mgmt.rb +67 -0
- data/test/manual/banner-tests/index.html +45 -0
- data/test/manual/banner-tests/svg.txt +3 -0
- data/test/manual/banner-tests/test01.html +122 -0
- data/test/manual/banner-tests/test02.html +122 -0
- data/test/manual/banner-tests/test03.html +122 -0
- data/test/manual/banner-tests/test04.html +129 -0
- data/test/manual/banner-tests/test05.html +129 -0
- data/test/manual/banner-tests/test06.html +129 -0
- data/test/manual/banner-tests/test07.html +129 -0
- data/test/manual/banner-tests/test08.html +123 -0
- data/test/manual/banner-tests/test09.html +123 -0
- data/test/manual/banner-tests/test10.html +123 -0
- data/test/manual/banner-tests/test11.html +123 -0
- data/test/manual/banner-tests/test12.html +123 -0
- data/test/manual/banner-tests/test13.html +123 -0
- data/test/manual/banner-tests/test14.html +123 -0
- data/test/manual/banner-tests/test15.html +122 -0
- data/test/manual/banner-tests/test16.html +122 -0
- data/test/manual/banner-tests/test17.html +122 -0
- data/test/manual/banner-tests/test18.html +132 -0
- data/test/manual/banner-tests/test19.html +132 -0
- data/test/manual/banner-tests/test20.html +132 -0
- data/test/manual/banner-tests/test21.html +132 -0
- data/test/manual/banner-tests/test22.html +132 -0
- data/test/manual/banner-tests/test23.html +132 -0
- data/test/manual/banner-tests/test24.html +132 -0
- data/test/manual/banner-tests/test25.html +131 -0
- data/test/manual/banner_environment.rb +205 -0
- data/test/manual/codemirror_demo.html +773 -0
- data/test/manual/create_posts_for_web.rb +114 -0
- data/test/manual/environment.rb +67 -0
- data/test/manual/make_banner.rb +153 -0
- data/test/manual/preview_manual_test.rb +129 -0
- data/test/manual/sample_banner_config.txt +12 -0
- data/test/manual/test_advanced_widgets.rb +73 -0
- data/test/manual/test_banner_combinations.rb +120 -0
- data/test/manual/test_banner_features.rb +306 -0
- data/test/manual/test_banner_integration.rb +115 -0
- data/test/manual/test_banner_radial.rb +87 -0
- data/test/manual/test_basic_posts.rb +47 -0
- data/test/manual/test_layout_widgets.rb +40 -0
- data/test/manual/test_pagination.rb +24 -0
- data/test/manual/test_random_posts.rb +38 -0
- data/test/manual/test_syntax_highlighting.rb +167 -0
- data/test/rubytext/rubytext_comprehensive_test.rb +307 -0
- data/test/rubytext/rubytext_demo_test.rb +42 -0
- data/test/rubytext/rubytext_testing_guide.md +277 -0
- data/test/run_automated_tests.rb +45 -0
- data/test/staging/.DS_Store +0 -0
- data/test/support/preview_utils.rb +88 -0
- data/test/syntax_highlighting_test.lt3 +124 -0
- data/test/test_gem_assets.rb +48 -0
- data/test/test_helpers.rb +240 -0
- data/test/tui_editor_integration_test.rb +296 -0
- data/test/tui_integration_test.rb +883 -0
- data/test/unit/api.rb +1776 -0
- data/test/unit/asset_management.rb +219 -0
- data/test/unit/backup_test.rb +451 -0
- data/test/unit/clipboard_test.rb +60 -0
- data/test/unit/contract_test.rb +69 -0
- data/test/unit/core.rb +1211 -0
- data/test/unit/deploy_config_test.rb +248 -0
- data/test/unit/deploy_test.rb +478 -0
- data/test/unit/edit_post_test.rb +168 -0
- data/test/unit/gem_asset_management.rb +183 -0
- data/test/unit/livetext_basic.rb +57 -0
- data/test/unit/livetext_compatibility.rb +82 -0
- data/test/unit/parse_cmd_test.rb +260 -0
- data/test/unit/permalink_copy_test.rb +211 -0
- data/test/unit/post.rb +309 -0
- data/test/unit/post_index_config_test.rb +258 -0
- data/test/unit/post_state_helpers_test.rb +137 -0
- data/test/unit/read_commented_file_test.rb +278 -0
- data/test/unit/reddit_test.rb +235 -0
- data/test/unit/repo.rb +569 -0
- data/test/unit/social_test.rb +366 -0
- data/test/unit/syntax_highlighting.rb +70 -0
- data/test/unit/theme_management_test.rb +91 -0
- data/test/unit/view.rb +498 -0
- data/test/unit/widgets.rb +669 -0
- data/test/web_integration_test.rb +231 -0
- data/test/web_test_helper.rb +218 -0
- data/test/web_workflow_test.rb +527 -0
- data/test/wizard_test.rb +123 -0
- data/ui/README.md +67 -0
- data/ui/common/lib/ui_common.rb +8 -0
- data/ui/rubytext/README.md +191 -0
- data/ui/rubytext/bin/scriptorium-rubytext +402 -0
- data/ui/rubytext/lib/rubytext_ui.rb +300 -0
- data/ui/tui/bin/scriptorium +1890 -0
- data/ui/tui/test/tui_test.rb +23 -0
- data/ui/web/app/app.rb +2600 -0
- data/ui/web/app/assets/livetext_mode.js +244 -0
- data/ui/web/app/error_helpers.rb +150 -0
- data/ui/web/app/views/advanced_config.erb +196 -0
- data/ui/web/app/views/asset_management.erb +645 -0
- data/ui/web/app/views/backup_management.erb +238 -0
- data/ui/web/app/views/banner_config.erb +200 -0
- data/ui/web/app/views/config_widget.erb +232 -0
- data/ui/web/app/views/configure_view.erb +401 -0
- data/ui/web/app/views/dashboard.erb +154 -0
- data/ui/web/app/views/deploy_config.erb +149 -0
- data/ui/web/app/views/edit_pages.erb +363 -0
- data/ui/web/app/views/edit_post.erb +175 -0
- data/ui/web/app/views/edit_theme.erb +73 -0
- data/ui/web/app/views/edit_theme_file.erb +74 -0
- data/ui/web/app/views/error_page.erb +29 -0
- data/ui/web/app/views/header_config.erb +155 -0
- data/ui/web/app/views/layout_config.erb +147 -0
- data/ui/web/app/views/navbar_config.erb +411 -0
- data/ui/web/app/views/theme_management.erb +130 -0
- data/ui/web/app/views/view_dashboard.erb +779 -0
- data/ui/web/app/views/widgets.erb +249 -0
- data/ui/web/bin/scriptorium-web +164 -0
- data/ui/web/test/web_basic_test.rb +38 -0
- data/ui/web/test_navbar.txt +7 -0
- data/ui/web/tmp/timing.log +17 -0
- data/ui/web/tmp/web_server.log +0 -0
- metadata +434 -8
- data/lib/scriptorium/engine.rb +0 -22
- data/test/engine/unit.rb +0 -44
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<title>The Forgotten Mathematician</title>
|
|
6
|
+
<meta name="generator" content="Scriptorium Import">
|
|
7
|
+
<meta property="og:title" content="The Forgotten Mathematician">
|
|
8
|
+
<meta property="og:locale" content="en_US">
|
|
9
|
+
<meta property="og:type" content="article">
|
|
10
|
+
<meta property="article:published_time" content="2019-12-25">
|
|
11
|
+
</head>
|
|
12
|
+
<body>
|
|
13
|
+
<article>
|
|
14
|
+
<header>
|
|
15
|
+
<h1>The Forgotten Mathematician</h1>
|
|
16
|
+
<time datetime="2019-12-25">December 25, 2019</time>
|
|
17
|
+
</header>
|
|
18
|
+
|
|
19
|
+
<div class="content">
|
|
20
|
+
<p>
|
|
21
|
+
We all know his name... but many of us only "sort of" know it.
|
|
22
|
+
|
|
23
|
+
<div class='mydrop'>W</div>
|
|
24
|
+
<div style="padding-top: 1px">e all remember Boole in our own way, if at all. His work comes up in discrete
|
|
25
|
+
math and in electrical engineering, among other places. But computer science students and
|
|
26
|
+
programmers in general remember him chiefly for the Boolean operators and the concept of the
|
|
27
|
+
Boolean data type.
|
|
28
|
+
|
|
29
|
+
<p>
|
|
30
|
+
I decided to Google for "who was Boole"... this was the result.
|
|
31
|
+
|
|
32
|
+
<p>
|
|
33
|
+
<img src='gooboo.png'></img>
|
|
34
|
+
|
|
35
|
+
<p>
|
|
36
|
+
|
|
37
|
+
<p>
|
|
38
|
+
Notice the top autocomplete. This seems to suggest that "Boolean" was the person's name. I
|
|
39
|
+
decided to make this blog post to set the record straight.
|
|
40
|
+
|
|
41
|
+
<p>
|
|
42
|
+
But that isn't the only reason I'm writing this. I want to speak up for this historical figure
|
|
43
|
+
just a little and correct what I perceive as a minor injustice.
|
|
44
|
+
|
|
45
|
+
<p>
|
|
46
|
+
Did anything look unusual in the previous sentences? Perhaps the capitalization of "Boolean"?
|
|
47
|
+
It's often lowercased in the computing community, and there are reasonable historical reasons
|
|
48
|
+
for this.
|
|
49
|
+
|
|
50
|
+
<p>
|
|
51
|
+
In the old days, it was often inconvenient or impossible to type or even to render lowercase
|
|
52
|
+
letters. As recently as the 1980s, I have seen terminals and printers that were strictly uppercase.
|
|
53
|
+
Take a look at a textbook or manual from that era, and you will often see the same thing.
|
|
54
|
+
|
|
55
|
+
<p>
|
|
56
|
+
On the other hand, people have always known that in English and similar languages, lowercase was
|
|
57
|
+
an essential part of reality. As it became practical to use computers for applications such as
|
|
58
|
+
typesetting and word processing, we started to take mixed case for granted.
|
|
59
|
+
|
|
60
|
+
<p>
|
|
61
|
+
Somewhere in this time frame (or a little earlier), UNIX came along. And yes, we did spell it
|
|
62
|
+
in all caps at the time. This was true of most computer language names and such, many of which
|
|
63
|
+
were some kind of acronym or abbreviation: FORTRAN, COBOL, BASIC. There was no particular reason
|
|
64
|
+
to put PASCAL in all caps... but people often did, out of a strange kind of habit.
|
|
65
|
+
|
|
66
|
+
<p>
|
|
67
|
+
But let's get back to UNIX. Have you ever wondered why we type <font size=+1><tt>ls</tt></font>, <font size=+1><tt>cp</tt></font>, and <font size=+1><tt>mv</tt></font> rather than
|
|
68
|
+
<font size=+1><tt>list</tt></font>, <font size=+1><tt>copy</tt></font>, and <font size=+1><tt>move</tt></font>? It's not just that old terminals could be slow to echo. One of the
|
|
69
|
+
UNIX creators basically <i>hated to type</i>. (I remember it as Brian Kernighan, but it may have been
|
|
70
|
+
Thompson or Ritchie.) And I argue this laziness also extended to a reluctance to type capital letters.
|
|
71
|
+
Can you think of a command flag that is capitalized (such as <font size=+1><tt>-F</tt></font>) <i>except</i> where the lowercase
|
|
72
|
+
(such as <font size=+1><tt>-f</tt></font>) was already used by something more fundamental? I can't think of one.
|
|
73
|
+
|
|
74
|
+
<p>
|
|
75
|
+
So as we made a transition from all-caps to mixed case, programming languages that were traditionally
|
|
76
|
+
written in upper case were now written in all lower case. In Pascal, we might once have written
|
|
77
|
+
<font size=+1><tt>FOR I:=1 TO 10</tt></font>, but a little later, we wrote <font size=+1><tt>for i:=1 to 10</tt></font> instead.
|
|
78
|
+
|
|
79
|
+
<p>
|
|
80
|
+
Do you see where this is going? Where we once wrote <font size=+1><tt>BOOLEAN</tt></font>, we wrote <font size=+1><tt>boolean</tt></font> instead. And
|
|
81
|
+
because we saw this so often in our programs, we started writing it that way when we wrote <i>about</i>
|
|
82
|
+
our programs.
|
|
83
|
+
|
|
84
|
+
<p>
|
|
85
|
+
Sometimes this is necessary. If you are using a language where identifiers are case-sensitive (like
|
|
86
|
+
most or all modern languages), there may well be an actual data type named <font size=+1><tt>boolean</tt></font>, and it would
|
|
87
|
+
be an error to capitalize it (even outside our code).
|
|
88
|
+
|
|
89
|
+
<p>
|
|
90
|
+
So typography matters here. For many years we have tended to write code in some kind of monospaced
|
|
91
|
+
typeface, harking back to the days when we had no choice in the matter. So consider these three
|
|
92
|
+
sentences, which might appear in any manual or piece of documentation:
|
|
93
|
+
|
|
94
|
+
<p>
|
|
95
|
+
<ol>
|
|
96
|
+
<li>This function takes a <font size=+1><tt>boolean</tt></font> parameter.</li>
|
|
97
|
+
<li>This function takes a boolean parameter.</li>
|
|
98
|
+
<li>This function takes a Boolean parameter.</li>
|
|
99
|
+
</ol>
|
|
100
|
+
It's reasonable to use lowercase in (1), because we're presumably referring to an actual identifier
|
|
101
|
+
or reserved word in some language. As for (2) — I think we see that all the time, but I'm arguing
|
|
102
|
+
here it's not appropriate. The usage in (3) is more appropriate.
|
|
103
|
+
|
|
104
|
+
<p>
|
|
105
|
+
Now, before I am misunderstood and/or flamed — here are the things I am <i>not</i> saying:
|
|
106
|
+
|
|
107
|
+
<p>
|
|
108
|
+
<ul>
|
|
109
|
+
<li> I'm not saying we should change the compilers or interpreters.</li>
|
|
110
|
+
<li> I'm not saying that all the books and manuals should be rewritten.</li>
|
|
111
|
+
<li> I'm not saying you're ignorant or a bad person if you don't capitalize "Boolean."</li>
|
|
112
|
+
<li> I'm not saying we should call out people who don't capitalize it.</li>
|
|
113
|
+
</ul>
|
|
114
|
+
But for comparison, let's look at some other scientists and mathematicians whose names have been
|
|
115
|
+
converted to adjectives. So far I have searched for these: Einsteinian, Newtonian, Galilean,
|
|
116
|
+
Ptolemaic, Copernican, Wronskian, Laplacian, Lagrangian, Riemannian, Euclidean, Keplerian,
|
|
117
|
+
Gaussian, Hamiltonian, Archimedean, Diophantine, Pythagorean, Darwinian, Lamarckian, Eulerian,
|
|
118
|
+
Cartesian, Napierian, Bayesian, and Brownian.
|
|
119
|
+
|
|
120
|
+
<p>
|
|
121
|
+
These terms have this in common: They are <i>always capitalized</i>. (Interestingly, <i>Abelian</i> seems
|
|
122
|
+
to be an exception in many people's usage.) And yes, you may find places where these names are
|
|
123
|
+
<i>not</i> given capital letters, but I contend they are very few in number.
|
|
124
|
+
|
|
125
|
+
<p>
|
|
126
|
+
Let's range further afield, into the realms of philosophers, religious figures, writers, and
|
|
127
|
+
artists. I have searched for these: Socratic, Aristotelian, Mosaic, Benedictine, Kafkaesque,
|
|
128
|
+
Epicurean, Shakespearean, Elizabethan, Edwardian, Spenserian, Petrarchan, Smithsonian, Botticellian,
|
|
129
|
+
Dickensian, Orwellian, Jungian, Freudian, and Adlerian. I've found very few uncapitalized
|
|
130
|
+
names. The lowercased <i>kafkaesque</i> is not unheard of, and we may informally call someone an
|
|
131
|
+
<i>epicurean</i> (though we refer specifically to the <i>Epicurean</i> philosophers in uppercase).
|
|
132
|
+
|
|
133
|
+
<p>
|
|
134
|
+
It's worth noting that units of measure named after people are not capitalized:
|
|
135
|
+
newton, ampere, coulomb, gauss, fermi, kelvin, henry, hertz, pascal, and watt. I can't find an
|
|
136
|
+
exception to this. Sometimes, though, the person's name is tacked on as <i>part</i> of the unit or
|
|
137
|
+
system of measure; we do capitalize the names when we refer to degrees Fahrenheit, degrees
|
|
138
|
+
Celsius, Richter scale, Mohs scale, and the Dobson unit.
|
|
139
|
+
|
|
140
|
+
<p>
|
|
141
|
+
Of course, in many cases, we just don't convert a name to a different form: Hilbert space,
|
|
142
|
+
Schwarzschild radius, Feynmann diagram, Bohr model, Fermi principle, Drake equation, Rohrschach
|
|
143
|
+
test, Hall effect, and so on. Why is this so common? I think it's because an adjective form
|
|
144
|
+
might often be hard to spell or pronounce, and overall we have less of a tendency for "fancy"
|
|
145
|
+
adjectives nowadays. But in any event, we'd never think of lowercasing these names.
|
|
146
|
+
|
|
147
|
+
<p>
|
|
148
|
+
And yet Boole is shortchanged so often in our world! Mathematicians talk about Boolean algebra,
|
|
149
|
+
and even electrical engineers talk of Boolean logic; but programmers talk of <i>boolean</i> data and
|
|
150
|
+
<i>boolean</i> operators.
|
|
151
|
+
|
|
152
|
+
<p>
|
|
153
|
+
Come on, guys. Give him his due. By the way, his first name was George.
|
|
154
|
+
|
|
155
|
+
<p>
|
|
156
|
+
So I am making a pledge: Where it's possible and practical, I will capitalize <i>Boolean</i> whenever
|
|
157
|
+
I write an article, a book, or a piece of documentation. I encourage you to do the same.
|
|
158
|
+
</div>
|
|
159
|
+
</article>
|
|
160
|
+
</body>
|
|
161
|
+
</html>
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
.h1 The Forgotten Mathematician
|
|
2
|
+
|
|
3
|
+
.set post.num = 0017
|
|
4
|
+
.set post.slug = the-forgotten-mathematician
|
|
5
|
+
.set post.date = 2019-12-25
|
|
6
|
+
.set post.title = The Forgotten Mathematician
|
|
7
|
+
.set post.tags =
|
|
8
|
+
.set post.views = computing
|
|
9
|
+
.set post.published = yes
|
|
10
|
+
.set post.deployed = no
|
|
11
|
+
|
|
12
|
+
We all know his name... but many of us only "sort of" know it.
|
|
13
|
+
|
|
14
|
+
W
|
|
15
|
+
e all remember Boole in our own way, if at all. His work comes up in discrete
|
|
16
|
+
math and in electrical engineering, among other places. But computer science students and
|
|
17
|
+
programmers in general remember him chiefly for the Boolean operators and the concept of the
|
|
18
|
+
Boolean data type.
|
|
19
|
+
|
|
20
|
+
I decided to Google for "who was Boole"... this was the result.
|
|
21
|
+
|
|
22
|
+
Notice the top autocomplete. This seems to suggest that "Boolean" was the person's name. I
|
|
23
|
+
decided to make this blog post to set the record straight.
|
|
24
|
+
|
|
25
|
+
But that isn't the only reason I'm writing this. I want to speak up for this historical figure
|
|
26
|
+
just a little and correct what I perceive as a minor injustice.
|
|
27
|
+
|
|
28
|
+
Did anything look unusual in the previous sentences? Perhaps the capitalization of "Boolean"?
|
|
29
|
+
It's often lowercased in the computing community, and there are reasonable historical reasons
|
|
30
|
+
for this.
|
|
31
|
+
|
|
32
|
+
In the old days, it was often inconvenient or impossible to type or even to render lowercase
|
|
33
|
+
letters. As recently as the 1980s, I have seen terminals and printers that were strictly uppercase.
|
|
34
|
+
Take a look at a textbook or manual from that era, and you will often see the same thing.
|
|
35
|
+
|
|
36
|
+
On the other hand, people have always known that in English and similar languages, lowercase was
|
|
37
|
+
an essential part of reality. As it became practical to use computers for applications such as
|
|
38
|
+
typesetting and word processing, we started to take mixed case for granted.
|
|
39
|
+
|
|
40
|
+
Somewhere in this time frame (or a little earlier), UNIX came along. And yes, we did spell it
|
|
41
|
+
in all caps at the time. This was true of most computer language names and such, many of which
|
|
42
|
+
were some kind of acronym or abbreviation: FORTRAN, COBOL, BASIC. There was no particular reason
|
|
43
|
+
to put PASCAL in all caps... but people often did, out of a strange kind of habit.
|
|
44
|
+
|
|
45
|
+
But let's get back to UNIX. Have you ever wondered why we type ls, cp, and mv rather than
|
|
46
|
+
list, copy, and move? It's not just that old terminals could be slow to echo. One of the
|
|
47
|
+
UNIX creators basically hated to type. (I remember it as Brian Kernighan, but it may have been
|
|
48
|
+
Thompson or Ritchie.) And I argue this laziness also extended to a reluctance to type capital letters.
|
|
49
|
+
Can you think of a command flag that is capitalized (such as -F) except where the lowercase
|
|
50
|
+
(such as -f) was already used by something more fundamental? I can't think of one.
|
|
51
|
+
|
|
52
|
+
So as we made a transition from all-caps to mixed case, programming languages that were traditionally
|
|
53
|
+
written in upper case were now written in all lower case. In Pascal, we might once have written
|
|
54
|
+
FOR I:=1 TO 10, but a little later, we wrote for i:=1 to 10 instead.
|
|
55
|
+
|
|
56
|
+
Do you see where this is going? Where we once wrote BOOLEAN, we wrote boolean instead. And
|
|
57
|
+
because we saw this so often in our programs, we started writing it that way when we wrote about
|
|
58
|
+
our programs.
|
|
59
|
+
|
|
60
|
+
Sometimes this is necessary. If you are using a language where identifiers are case-sensitive (like
|
|
61
|
+
most or all modern languages), there may well be an actual data type named boolean, and it would
|
|
62
|
+
be an error to capitalize it (even outside our code).
|
|
63
|
+
|
|
64
|
+
So typography matters here. For many years we have tended to write code in some kind of monospaced
|
|
65
|
+
typeface, harking back to the days when we had no choice in the matter. So consider these three
|
|
66
|
+
sentences, which might appear in any manual or piece of documentation:
|
|
67
|
+
|
|
68
|
+
This function takes a boolean parameter.
|
|
69
|
+
This function takes a boolean parameter.
|
|
70
|
+
This function takes a Boolean parameter.
|
|
71
|
+
|
|
72
|
+
It's reasonable to use lowercase in (1), because we're presumably referring to an actual identifier
|
|
73
|
+
or reserved word in some language. As for (2) — I think we see that all the time, but I'm arguing
|
|
74
|
+
here it's not appropriate. The usage in (3) is more appropriate.
|
|
75
|
+
|
|
76
|
+
Now, before I am misunderstood and/or flamed — here are the things I am not saying:
|
|
77
|
+
|
|
78
|
+
I'm not saying we should change the compilers or interpreters.
|
|
79
|
+
I'm not saying that all the books and manuals should be rewritten.
|
|
80
|
+
I'm not saying you're ignorant or a bad person if you don't capitalize "Boolean."
|
|
81
|
+
I'm not saying we should call out people who don't capitalize it.
|
|
82
|
+
|
|
83
|
+
But for comparison, let's look at some other scientists and mathematicians whose names have been
|
|
84
|
+
converted to adjectives. So far I have searched for these: Einsteinian, Newtonian, Galilean,
|
|
85
|
+
Ptolemaic, Copernican, Wronskian, Laplacian, Lagrangian, Riemannian, Euclidean, Keplerian,
|
|
86
|
+
Gaussian, Hamiltonian, Archimedean, Diophantine, Pythagorean, Darwinian, Lamarckian, Eulerian,
|
|
87
|
+
Cartesian, Napierian, Bayesian, and Brownian.
|
|
88
|
+
|
|
89
|
+
These terms have this in common: They are always capitalized. (Interestingly, Abelian seems
|
|
90
|
+
to be an exception in many people's usage.) And yes, you may find places where these names are
|
|
91
|
+
not given capital letters, but I contend they are very few in number.
|
|
92
|
+
|
|
93
|
+
Let's range further afield, into the realms of philosophers, religious figures, writers, and
|
|
94
|
+
artists. I have searched for these: Socratic, Aristotelian, Mosaic, Benedictine, Kafkaesque,
|
|
95
|
+
Epicurean, Shakespearean, Elizabethan, Edwardian, Spenserian, Petrarchan, Smithsonian, Botticellian,
|
|
96
|
+
Dickensian, Orwellian, Jungian, Freudian, and Adlerian. I've found very few uncapitalized
|
|
97
|
+
names. The lowercased kafkaesque is not unheard of, and we may informally call someone an
|
|
98
|
+
epicurean (though we refer specifically to the Epicurean philosophers in uppercase).
|
|
99
|
+
|
|
100
|
+
It's worth noting that units of measure named after people are not capitalized:
|
|
101
|
+
newton, ampere, coulomb, gauss, fermi, kelvin, henry, hertz, pascal, and watt. I can't find an
|
|
102
|
+
exception to this. Sometimes, though, the person's name is tacked on as part of the unit or
|
|
103
|
+
system of measure; we do capitalize the names when we refer to degrees Fahrenheit, degrees
|
|
104
|
+
Celsius, Richter scale, Mohs scale, and the Dobson unit.
|
|
105
|
+
|
|
106
|
+
Of course, in many cases, we just don't convert a name to a different form: Hilbert space,
|
|
107
|
+
Schwarzschild radius, Feynmann diagram, Bohr model, Fermi principle, Drake equation, Rohrschach
|
|
108
|
+
test, Hall effect, and so on. Why is this so common? I think it's because an adjective form
|
|
109
|
+
might often be hard to spell or pronounce, and overall we have less of a tendency for "fancy"
|
|
110
|
+
adjectives nowadays. But in any event, we'd never think of lowercasing these names.
|
|
111
|
+
|
|
112
|
+
And yet Boole is shortchanged so often in our world! Mathematicians talk about Boolean algebra,
|
|
113
|
+
and even electrical engineers talk of Boolean logic; but programmers talk of boolean data and
|
|
114
|
+
boolean operators.
|
|
115
|
+
|
|
116
|
+
Come on, guys. Give him his due. By the way, his first name was George.
|
|
117
|
+
|
|
118
|
+
So I am making a pledge: Where it's possible and practical, I will capitalize Boolean whenever
|
|
119
|
+
I write an article, a book, or a piece of documentation. I encourage you to do the same.
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<title>Ruby puns</title>
|
|
6
|
+
<meta name="generator" content="Scriptorium Import">
|
|
7
|
+
<meta property="og:title" content="Ruby puns">
|
|
8
|
+
<meta property="og:locale" content="en_US">
|
|
9
|
+
<meta property="og:type" content="article">
|
|
10
|
+
<meta property="article:published_time" content="2020-01-21">
|
|
11
|
+
</head>
|
|
12
|
+
<body>
|
|
13
|
+
<article>
|
|
14
|
+
<header>
|
|
15
|
+
<h1>Ruby puns</h1>
|
|
16
|
+
<time datetime="2020-01-21">January 21, 2020</time>
|
|
17
|
+
</header>
|
|
18
|
+
|
|
19
|
+
<div class="content">
|
|
20
|
+
<p>
|
|
21
|
+
These are pretty bad. You've been warned.
|
|
22
|
+
|
|
23
|
+
<p>
|
|
24
|
+
<pre>
|
|
25
|
+
cheese = "" # String cheese
|
|
26
|
+
browns = {} # Hash browns
|
|
27
|
+
hiphip = [] # hiphip array
|
|
28
|
+
case; end # brief case
|
|
29
|
+
foods.freeze # frozen foods
|
|
30
|
+
love.taint # tainted love
|
|
31
|
+
attr_writer :irish # Irish setter
|
|
32
|
+
{"corned" => "beef"} # corned beef hash
|
|
33
|
+
raise "hell" # raising hell
|
|
34
|
+
$village # global village
|
|
35
|
+
|
|
36
|
+
usual_suspects = 1.99
|
|
37
|
+
usual_suspects.ceil # round up the usual suspects
|
|
38
|
+
|
|
39
|
+
class JesusChrist < God
|
|
40
|
+
super(*) # Jesus Christ Superstar
|
|
41
|
+
end
|
|
42
|
+
</pre>
|
|
43
|
+
</div>
|
|
44
|
+
</article>
|
|
45
|
+
</body>
|
|
46
|
+
</html>
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
.h1 Ruby puns
|
|
2
|
+
|
|
3
|
+
.set post.num = 0018
|
|
4
|
+
.set post.slug = ruby-puns
|
|
5
|
+
.set post.date = 2020-01-21
|
|
6
|
+
.set post.title = Ruby puns
|
|
7
|
+
.set post.tags =
|
|
8
|
+
.set post.views = computing computing
|
|
9
|
+
.set post.published = yes
|
|
10
|
+
.set post.deployed = no
|
|
11
|
+
|
|
12
|
+
These are pretty bad. You've been warned.
|
|
13
|
+
|
|
14
|
+
cheese = "" # String cheese
|
|
15
|
+
browns = {} # Hash browns
|
|
16
|
+
hiphip = [] # hiphip array
|
|
17
|
+
case; end # brief case
|
|
18
|
+
foods.freeze # frozen foods
|
|
19
|
+
love.taint # tainted love
|
|
20
|
+
attr_writer :irish # Irish setter
|
|
21
|
+
{"corned" => "beef"} # corned beef hash
|
|
22
|
+
raise "hell" # raising hell
|
|
23
|
+
$village # global village
|
|
24
|
+
|
|
25
|
+
usual_suspects = 1.99
|
|
26
|
+
usual_suspects.ceil # round up the usual suspects
|
|
27
|
+
|
|
28
|
+
class JesusChrist
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<title>Custom exceptions via metaprogramming</title>
|
|
6
|
+
<meta name="generator" content="Scriptorium Import">
|
|
7
|
+
<meta property="og:title" content="Custom exceptions via metaprogramming">
|
|
8
|
+
<meta property="og:locale" content="en_US">
|
|
9
|
+
<meta property="og:type" content="article">
|
|
10
|
+
<meta property="article:published_time" content="2020-02-17">
|
|
11
|
+
</head>
|
|
12
|
+
<body>
|
|
13
|
+
<article>
|
|
14
|
+
<header>
|
|
15
|
+
<h1>Custom exceptions via metaprogramming</h1>
|
|
16
|
+
<time datetime="2020-02-17">February 17, 2020</time>
|
|
17
|
+
</header>
|
|
18
|
+
|
|
19
|
+
<div class="content">
|
|
20
|
+
<p>
|
|
21
|
+
Suppose you want a large number of custom exceptions. And suppose you're not afraid of metaprogramming.
|
|
22
|
+
A few months back, I found myself wanting to be "more specific" with the exceptions
|
|
23
|
+
I raised in my ongoing RuneBlog project (which is used to create this blog). I
|
|
24
|
+
wanted to raise specific exceptions with custom parameterized messages (without
|
|
25
|
+
repeating myself too much).
|
|
26
|
+
|
|
27
|
+
<p>
|
|
28
|
+
Here's an example of the "usual" way to do this:
|
|
29
|
+
|
|
30
|
+
<p>
|
|
31
|
+
<div class="highlight">
|
|
32
|
+
<span class="k">class</span> <span class="nc">MyException</span> <span class="o"><</span> <span class="no">StandardError</span>
|
|
33
|
+
|
|
34
|
+
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">file</span><span class="p">,</span> <span class="n">dir</span><span class="p">)</span>
|
|
35
|
+
<span class="n">msg</span> <span class="o">=</span> <span class="s2">"Could not find </span><span class="si">#{</span><span class="n">file</span><span class="si">}</span><span class="s2"> under </span><span class="si">#{</span><span class="n">dir</span><span class="si">}</span><span class="s2">"</span>
|
|
36
|
+
<span class="k">super</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
|
|
37
|
+
<span class="k">end</span>
|
|
38
|
+
|
|
39
|
+
<span class="k">end</span>
|
|
40
|
+
|
|
41
|
+
<span class="k">raise</span> <span class="no">MyException</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="s2">"stuff.txt"</span><span class="p">,</span> <span class="s2">"/home/willard"</span><span class="p">)</span>
|
|
42
|
+
|
|
43
|
+
<span class="c1"># Output:</span>
|
|
44
|
+
<span class="c1"># exc.rb:10:in `<main>': Could not find stuff.txt under /home/willard (MyException)</span>
|
|
45
|
+
</div>
|
|
46
|
+
<br>
|
|
47
|
+
Now there is nothing particularly wrong with that. But as it happens, I wanted a
|
|
48
|
+
large number of exceptions with fairly descriptive names. I didn't want to type
|
|
49
|
+
(or even paste) this stuff over and over.
|
|
50
|
+
|
|
51
|
+
<p>
|
|
52
|
+
Here comes the "not afraid of metaprogramming" part. This is what I did:
|
|
53
|
+
|
|
54
|
+
<p>
|
|
55
|
+
<div class="highlight">
|
|
56
|
+
<span class="k">def</span> <span class="nf">make_exception</span><span class="p">(</span><span class="n">sym</span><span class="p">,</span> <span class="n">str</span><span class="p">,</span> <span class="n">target_class</span> <span class="o">=</span> <span class="no">Object</span><span class="p">)</span>
|
|
57
|
+
<span class="k">return</span> <span class="k">if</span> <span class="n">target_class</span><span class="p">.</span><span class="nf">constants</span><span class="p">.</span><span class="nf">include?</span><span class="p">(</span><span class="n">sym</span><span class="p">)</span>
|
|
58
|
+
<span class="n">target_class</span><span class="p">.</span><span class="nf">const_set</span><span class="p">(</span><span class="n">sym</span><span class="p">,</span> <span class="no">StandardError</span><span class="p">.</span><span class="nf">dup</span><span class="p">)</span>
|
|
59
|
+
<span class="n">define_method</span><span class="p">(</span><span class="n">sym</span><span class="p">)</span> <span class="k">do</span> <span class="o">|*</span><span class="n">args</span><span class="o">|</span>
|
|
60
|
+
<span class="n">msg</span> <span class="o">=</span> <span class="n">str</span><span class="p">.</span><span class="nf">dup</span>
|
|
61
|
+
<span class="n">args</span><span class="p">.</span><span class="nf">each</span><span class="p">.</span><span class="nf">with_index</span> <span class="p">{</span><span class="o">|</span><span class="n">arg</span><span class="p">,</span> <span class="n">i</span><span class="o">|</span> <span class="n">msg</span><span class="p">.</span><span class="nf">sub!</span><span class="p">(</span><span class="s2">"%</span><span class="si">#{</span><span class="n">i</span><span class="o">+</span><span class="mi">1</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span> <span class="n">arg</span><span class="p">)</span> <span class="p">}</span>
|
|
62
|
+
<span class="n">target_class</span><span class="p">.</span><span class="nf">class_eval</span><span class="p">(</span><span class="n">sym</span><span class="p">.</span><span class="nf">to_s</span><span class="p">).</span><span class="nf">new</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
|
|
63
|
+
<span class="k">end</span>
|
|
64
|
+
<span class="k">end</span>
|
|
65
|
+
</div>
|
|
66
|
+
<br>
|
|
67
|
+
Now, what does this do? The method takes two parameters (or three if you count the
|
|
68
|
+
target class which defaults to <font size=+1><tt>Object</tt></font>). You specify a symbol (for the
|
|
69
|
+
name of the exception) and a string (for the exception message). It then does
|
|
70
|
+
two things: It creates an exception class (named after the symbol); and it creates
|
|
71
|
+
a method of the same name.
|
|
72
|
+
|
|
73
|
+
<p>
|
|
74
|
+
Here are examples of calling <font size=+1><tt>make_exception</tt></font>:
|
|
75
|
+
|
|
76
|
+
<p>
|
|
77
|
+
<div class="highlight">
|
|
78
|
+
<span class="n">make_exception</span><span class="p">(</span><span class="ss">:NotImplemented</span><span class="p">,</span> <span class="s2">"Feature not yet implemented"</span><span class="p">)</span>
|
|
79
|
+
<span class="n">make_exception</span><span class="p">(</span><span class="ss">:CantOpen</span><span class="p">,</span> <span class="s2">"Can't open '%1'"</span><span class="p">)</span>
|
|
80
|
+
<span class="n">make_exception</span><span class="p">(</span><span class="ss">:InternalError</span><span class="p">,</span> <span class="s2">"Internal error: Method %1 got arg '%2'"</span><span class="p">)</span>
|
|
81
|
+
</div>
|
|
82
|
+
<br>
|
|
83
|
+
And here are examples of raising these exceptions:
|
|
84
|
+
|
|
85
|
+
<p>
|
|
86
|
+
<div class="highlight">
|
|
87
|
+
<span class="k">raise</span> <span class="no">NotImplemented</span>
|
|
88
|
+
<span class="k">raise</span> <span class="no">CantOpen</span><span class="p">(</span><span class="n">somefile</span><span class="p">)</span>
|
|
89
|
+
<span class="k">raise</span> <span class="no">InternalError</span><span class="p">(</span><span class="n">__method__</span><span class="p">,</span> <span class="n">arg</span><span class="p">)</span>
|
|
90
|
+
</div>
|
|
91
|
+
<br>
|
|
92
|
+
You might ask: Why define a method returning an exception object? The answer
|
|
93
|
+
is that I don't want to write these this way:
|
|
94
|
+
|
|
95
|
+
<p>
|
|
96
|
+
<div class="highlight">
|
|
97
|
+
<span class="k">raise</span> <span class="no">NotImplemented</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="s2">"Feature not yet implemented"</span><span class="p">)</span>
|
|
98
|
+
<span class="k">raise</span> <span class="no">CantOpen</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="s2">"Can't open '</span><span class="si">#{</span><span class="n">somefile</span><span class="si">}</span><span class="s2">'"</span><span class="p">)</span>
|
|
99
|
+
<span class="k">raise</span> <span class="no">InternalError</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="s2">"Internal error: Method </span><span class="si">#{</span><span class="n">__method__</span><span class="si">}</span><span class="s2"> got arg '</span><span class="si">#{</span><span class="n">arg</span><span class="si">}</span><span class="s2">'"</span><span class="p">)</span>
|
|
100
|
+
</div>
|
|
101
|
+
<br>
|
|
102
|
+
I perceive four advantages doing it the first way: I don't have to specify the
|
|
103
|
+
message string each time; I still get to have a descriptive, unique class name
|
|
104
|
+
without the message making it seem redundantly; I don't have to interpolate
|
|
105
|
+
values into the message string explicitly; and I don't have to say <font size=+1><tt>.new</tt></font>
|
|
106
|
+
every time.
|
|
107
|
+
|
|
108
|
+
<p>
|
|
109
|
+
Some of you may have two questions: Can you (or should you) really have a
|
|
110
|
+
capitalized method name? Can a method have the same name as a class without
|
|
111
|
+
confusing the interpreter?
|
|
112
|
+
|
|
113
|
+
<p>
|
|
114
|
+
I'll answer both those questions with an example from the Ruby core: There
|
|
115
|
+
is an <font size=+1><tt>Integer</tt></font> class and an <font size=+1><tt>Integer</tt></font> method (naturally related to each other).
|
|
116
|
+
Ruby distinguishes between these by context. It's not impossible, and I argue
|
|
117
|
+
it's not a bad practice.
|
|
118
|
+
|
|
119
|
+
<p>
|
|
120
|
+
As for the parameters, it's intuitive how they work. A <font size=+1><tt>%</tt></font> sign signals a
|
|
121
|
+
numbered replaceable piece of text, and these are replaced with the parameters
|
|
122
|
+
specified when the method is called.
|
|
123
|
+
|
|
124
|
+
<p>
|
|
125
|
+
That part of the code is not really robust, by the way. As it is written now,you could easily confuse it-- make it misbehave or crash. But you get the idea.
|
|
126
|
+
|
|
127
|
+
<p>
|
|
128
|
+
So far, I have defined 23 custom exceptions in this project. Each definition
|
|
129
|
+
occupies a single line. If I want to change the behavior of all of them in
|
|
130
|
+
some way, I will go and change the <font size=+1><tt>make_exception</tt></font> method (which itself is
|
|
131
|
+
only 9 lines).
|
|
132
|
+
|
|
133
|
+
<p>
|
|
134
|
+
Like it, hate it? Comments welcome.
|
|
135
|
+
</div>
|
|
136
|
+
</article>
|
|
137
|
+
</body>
|
|
138
|
+
</html>
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
.h1 Custom exceptions via metaprogramming
|
|
2
|
+
|
|
3
|
+
.set post.num = 0019
|
|
4
|
+
.set post.slug = custom-exceptions-via-metaprogramming
|
|
5
|
+
.set post.date = 2020-02-17
|
|
6
|
+
.set post.title = Custom exceptions via metaprogramming
|
|
7
|
+
.set post.tags =
|
|
8
|
+
.set post.views = computing computing
|
|
9
|
+
.set post.published = yes
|
|
10
|
+
.set post.deployed = no
|
|
11
|
+
|
|
12
|
+
Suppose you want a large number of custom exceptions. And suppose you're not afraid of metaprogramming.
|
|
13
|
+
A few months back, I found myself wanting to be "more specific" with the exceptions
|
|
14
|
+
I raised in my ongoing RuneBlog project (which is used to create this blog). I
|
|
15
|
+
wanted to raise specific exceptions with custom parameterized messages (without
|
|
16
|
+
repeating myself too much).
|
|
17
|
+
|
|
18
|
+
Here's an example of the "usual" way to do this:
|
|
19
|
+
|
|
20
|
+
class MyException < StandardError
|
|
21
|
+
|
|
22
|
+
def initialize(file, dir)
|
|
23
|
+
msg = "Could not find #{file} under #{dir}"
|
|
24
|
+
super(msg)
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
raise MyException.new("stuff.txt", "/home/willard")
|
|
30
|
+
|
|
31
|
+
# Output:
|
|
32
|
+
# exc.rb:10:in `<main>': Could not find stuff.txt under /home/willard (MyException)
|
|
33
|
+
|
|
34
|
+
Now there is nothing particularly wrong with that. But as it happens, I wanted a
|
|
35
|
+
large number of exceptions with fairly descriptive names. I didn't want to type
|
|
36
|
+
(or even paste) this stuff over and over.
|
|
37
|
+
|
|
38
|
+
Here comes the "not afraid of metaprogramming" part. This is what I did:
|
|
39
|
+
|
|
40
|
+
def make_exception(sym, str, target_class = Object)
|
|
41
|
+
return if target_class.constants.include?(sym)
|
|
42
|
+
target_class.const_set(sym, StandardError.dup)
|
|
43
|
+
define_method(sym) do |*args|
|
|
44
|
+
msg = str.dup
|
|
45
|
+
args.each.with_index {|arg, i| msg.sub!("%#{i+1}", arg) }
|
|
46
|
+
target_class.class_eval(sym.to_s).new(msg)
|
|
47
|
+
end
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
Now, what does this do? The method takes two parameters (or three if you count the
|
|
51
|
+
target class which defaults to Object). You specify a symbol (for the
|
|
52
|
+
name of the exception) and a string (for the exception message). It then does
|
|
53
|
+
two things: It creates an exception class (named after the symbol); and it creates
|
|
54
|
+
a method of the same name.
|
|
55
|
+
|
|
56
|
+
Here are examples of calling make_exception:
|
|
57
|
+
|
|
58
|
+
make_exception(:NotImplemented, "Feature not yet implemented")
|
|
59
|
+
make_exception(:CantOpen, "Can't open '%1'")
|
|
60
|
+
make_exception(:InternalError, "Internal error: Method %1 got arg '%2'")
|
|
61
|
+
|
|
62
|
+
And here are examples of raising these exceptions:
|
|
63
|
+
|
|
64
|
+
raise NotImplemented
|
|
65
|
+
raise CantOpen(somefile)
|
|
66
|
+
raise InternalError(__method__, arg)
|
|
67
|
+
|
|
68
|
+
You might ask: Why define a method returning an exception object? The answer
|
|
69
|
+
is that I don't want to write these this way:
|
|
70
|
+
|
|
71
|
+
raise NotImplemented.new("Feature not yet implemented")
|
|
72
|
+
raise CantOpen.new("Can't open '#{somefile}'")
|
|
73
|
+
raise InternalError.new("Internal error: Method #{__method__} got arg '#{arg}'")
|
|
74
|
+
|
|
75
|
+
I perceive four advantages doing it the first way: I don't have to specify the
|
|
76
|
+
message string each time; I still get to have a descriptive, unique class name
|
|
77
|
+
without the message making it seem redundantly; I don't have to interpolate
|
|
78
|
+
values into the message string explicitly; and I don't have to say .new
|
|
79
|
+
every time.
|
|
80
|
+
|
|
81
|
+
Some of you may have two questions: Can you (or should you) really have a
|
|
82
|
+
capitalized method name? Can a method have the same name as a class without
|
|
83
|
+
confusing the interpreter?
|
|
84
|
+
|
|
85
|
+
I'll answer both those questions with an example from the Ruby core: There
|
|
86
|
+
is an Integer class and an Integer method (naturally related to each other).
|
|
87
|
+
Ruby distinguishes between these by context. It's not impossible, and I argue
|
|
88
|
+
it's not a bad practice.
|
|
89
|
+
|
|
90
|
+
As for the parameters, it's intuitive how they work. A % sign signals a
|
|
91
|
+
numbered replaceable piece of text, and these are replaced with the parameters
|
|
92
|
+
specified when the method is called.
|
|
93
|
+
|
|
94
|
+
That part of the code is not really robust, by the way. As it is written now,you could easily confuse it-- make it misbehave or crash. But you get the idea.
|
|
95
|
+
|
|
96
|
+
So far, I have defined 23 custom exceptions in this project. Each definition
|
|
97
|
+
occupies a single line. If I want to change the behavior of all of them in
|
|
98
|
+
some way, I will go and change the make_exception method (which itself is
|
|
99
|
+
only 9 lines).
|
|
100
|
+
|
|
101
|
+
Like it, hate it? Comments welcome.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<title>fffff</title>
|
|
6
|
+
<meta name="generator" content="Scriptorium Import">
|
|
7
|
+
<meta property="og:title" content="fffff">
|
|
8
|
+
<meta property="og:locale" content="en_US">
|
|
9
|
+
<meta property="og:type" content="article">
|
|
10
|
+
<meta property="article:published_time" content="2020-01-21">
|
|
11
|
+
</head>
|
|
12
|
+
<body>
|
|
13
|
+
<article>
|
|
14
|
+
<header>
|
|
15
|
+
<h1>fffff</h1>
|
|
16
|
+
<time datetime="2020-01-21">January 21, 2020</time>
|
|
17
|
+
</header>
|
|
18
|
+
|
|
19
|
+
<div class="content">
|
|
20
|
+
<p>
|
|
21
|
+
</div>
|
|
22
|
+
</article>
|
|
23
|
+
</body>
|
|
24
|
+
</html>
|